diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/vpcipam | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/vpcipam')
| -rw-r--r-- | data/zh_cn/vpcipam/2023-02-28/api-docs.php | 10302 |
1 files changed, 10302 insertions, 0 deletions
diff --git a/data/zh_cn/vpcipam/2023-02-28/api-docs.php b/data/zh_cn/vpcipam/2023-02-28/api-docs.php new file mode 100644 index 0000000..981b011 --- /dev/null +++ b/data/zh_cn/vpcipam/2023-02-28/api-docs.php @@ -0,0 +1,10302 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'VpcIpam', + 'version' => '2023-02-28', + ], + 'directories' => [ + [ + 'children' => [ + 'RemoveIpamMembers', + 'ListIpamMembers', + 'AddIpamMembers', + ], + 'type' => 'directory', + 'title' => 'IPAM多账号管理', + 'id' => 305631, + ], + [ + 'children' => [ + 'OpenVpcIpamService', + 'GetVpcIpamServiceStatus', + 'CreateIpam', + 'DeleteIpam', + 'UpdateIpam', + 'ListIpams', + ], + 'type' => 'directory', + 'title' => 'IPAM', + 'id' => 89719, + ], + [ + 'children' => [ + 'CreateIpamScope', + 'DeleteIpamScope', + 'UpdateIpamScope', + 'ListIpamScopes', + 'ListIpamResourceCidrs', + ], + 'type' => 'directory', + 'title' => 'IPAM作用范围', + 'id' => 170709, + ], + [ + 'children' => [ + 'CreateIpamPool', + 'DeleteIpamPool', + 'UpdateIpamPool', + 'ListIpamPools', + 'AddIpamPoolCidr', + 'DeleteIpamPoolCidr', + 'ListIpamPoolCidrs', + 'CreateIpamPoolAllocation', + 'DeleteIpamPoolAllocation', + 'UpdateIpamPoolAllocation', + 'GetIpamPoolAllocation', + 'ListIpamPoolAllocations', + 'GetIpamPoolNextAvailableCidr', + ], + 'type' => 'directory', + 'title' => 'IPAM地址池', + 'id' => 89732, + ], + [ + 'children' => [ + 'CreateIpamResourceDiscovery', + 'DeleteIpamResourceDiscovery', + 'UpdateIpamResourceDiscovery', + 'ListIpamResourceDiscoveries', + 'AssociateIpamResourceDiscovery', + 'DissociateIpamResourceDiscovery', + 'ListIpamResourceDiscoveryAssociations', + 'ListIpamDiscoveredResource', + ], + 'type' => 'directory', + 'title' => '资源发现', + 'id' => 89752, + ], + [ + 'children' => [ + 'ChangeResourceGroup', + ], + 'type' => 'directory', + 'title' => '资源组', + 'id' => 89746, + ], + [ + 'children' => [ + 'TagResources', + 'UntagResources', + 'ListTagResources', + ], + 'type' => 'directory', + 'title' => '标签', + 'id' => 89748, + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AddIpamMembers' => [ + 'summary' => '添加IPAM可信服务纳管成员。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会添加IPAM可信服务纳管成员。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并添加IPAM可信服务纳管成员。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。'."\n" + ."\n" + .'从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的**RequestId**作为**ClientToken**标识。每次API请求的**RequestId**可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Members', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IPAM可信服务纳管成员。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MemberId' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'- **Folder ID**：资源夹ID。'."\n" + ."\n" + .'- **Account UID**：资源目录成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => 'fd-ccccncASqa', + ], + 'MemberType' => [ + 'description' => '成员类型，取值：'."\n" + ."\n" + .'- **Folder**：资源夹。'."\n" + ."\n" + .'- **Account**：资源目录成员账号。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Account' => '资源目录成员账号', + 'Folder' => '资源夹', + ], + 'example' => 'Folder', + 'enum' => [ + 'Account', + 'Folder', + ], + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.MemberIdNotMatchMemberType', + 'errorMessage' => 'The operation is not allowed because the Member ID and Member Type of members [%s] in the input parameters do not match.', + 'description' => '入参Members中[%s]的Member Id和Member Type不匹配。', + ], + [ + 'errorCode' => 'OperationDenied.MemberExistInIpamRDService', + 'errorMessage' => 'The operation is not allowed because %s is under the management of the IPAM.', + 'description' => '入参中%s已经被IPAM可信服务纳管，不允许重复纳管相同的member。', + ], + [ + 'errorCode' => 'QuotaExceeded.MemberAccount', + 'errorMessage' => 'The operation is not allowed because the number of % managed by IPAM has exceeded the limit, %s/%s.', + 'description' => 'IPAM可信服务纳管的成员账号超过Quota限制。', + ], + [ + 'errorCode' => 'OperationDenied.IpamResourceDiscoveryAlreadySharedWithAdmin', + 'errorMessage' => 'The operation is not allowed because the resource discovery has been shared with the IPAM delegated administrator by %s.', + 'description' => 'IPAM可信服务不允许纳管已经将自己的资源发现共享给委派管理员的账号。', + ], + [ + 'errorCode' => 'OperationDenied.IpamRDServiceAlreadyEnabledInOtherRegion', + 'errorMessage' => 'The operation is not allowed because the IPAM Resource Directory service is already enabled in another region.', + 'description' => '只允许选择一个地域的一个IPAM实例纳管资源目录成员。', + ], + [ + 'errorCode' => 'OperationDenied.AccountNotRDEntity', + 'errorMessage' => 'The operation is not allowed because the caller does not belong to the resource directory.', + 'description' => '调用者不属于任何资源目录，不允许纳管IPAM可信服务成员。', + ], + [ + 'errorCode' => 'OperationDenied.NotDelegatedAdminAccount', + 'errorMessage' => 'The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory.', + 'description' => '调用者不是所在资源目录的IPAM可信服务委派管理员，不允许纳管IPAM可信服务成员。', + ], + [ + 'errorCode' => 'OperationDenied.IpamNotExist', + 'errorMessage' => 'The operation is not allowed because the IPAM does not exist.', + 'description' => '当前地域IPAM不存在，不允许纳管IPAM可信服务成员。', + ], + [ + 'errorCode' => 'OperationDenied.DelegateAdminAsMember', + 'errorMessage' => 'The operation is not allowed because the IPAM delegate administrator cannot be a member.', + 'description' => 'IPAM委派管理员不能添加自己作为IPAM可信服务的成员。', + ], + [ + 'errorCode' => 'OperationDenied.NoServicePrincipalAdminPrivileges', + 'errorMessage' => 'The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory.', + 'description' => '调用者不是所在资源目录的IPAM可信服务委派管理员，不允许纳管IPAM可信服务成员。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '添加IPAM可信服务纳管成员', + 'description' => '- IPAM多账号管理仅支持资源目录IPAM委派管理员进行操作。'."\n" + .'- 仅允许IPAM委派管理员选择一个地域的IPAM进行多账号管理，支持纳管的成员账号总计不超过1000。'."\n" + .'<notice>当纳管成员为Folder类型时，按Folder下包含的资源目录成员账号计数。</notice>'."\n" + .'- 纳管成员类型包含Folder和Account'."\n" + .' - Folder：IPAM委派管理员可查看Folder下所有资源目录成员账号在IPAM生效地域的IP使用情况；'."\n" + .' - Account：IPAM委派管理员可查看指定资源目录账号在IPAM生效地域的IP使用情况。'."\n" + .'- 已纳管成员不允许将资源发现共享给IPAM委派管理员，IPAM委派管理员也不允许纳管已将资源发现共享给自己的成员。'."\n" + .'- IPAM委派管理员首次添加纳管成员后，资源目录IPAM可信服务开启。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\"\\n}","type":"json"}]', + ], + 'AddIpamPoolCidr' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173978', + 'abilityTreeNodes' => [ + 'FEATUREvpcNCDGSE', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'Cidr', + 'in' => 'query', + 'schema' => [ + 'description' => '要预置的CIDR地址段。'."\n" + ."\n" + .'> 私网顶级池仅支持通过输入CIDR地址段的方式进行预置。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.0/24', + ], + ], + [ + 'name' => 'NetmaskLength', + 'in' => 'query', + 'schema' => [ + 'description' => '通过掩码的方式预置CIDR地址段。'."\n" + ."\n" + .'> 公网IPv6顶级池仅支持通过掩码的方式进行预置。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '24', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会为IPAM地址池预置CIDR地址段。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '558BC336-8B88-53B0-B4AD-980EE900AB01', + ], + 'Cidr' => [ + 'description' => '地址池成功预置的CIDR地址段。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam.IpVersion', + 'errorMessage' => 'The specified IpVersion is illegal.', + 'description' => 'IpVersion参数不合法。'."\n", + ], + [ + 'errorCode' => 'UnsupportedFeature.PublicIpamScopeType', + 'errorMessage' => 'The feature of PublicIpamScopeType is not supported.', + 'description' => '您指定的IPAM暂不支持创建Public类型的作用范围。', + ], + [ + 'errorCode' => 'IllegalParam.IpamPool', + 'errorMessage' => 'The specified IPAM pool cannot be empty.', + 'description' => 'IPAM Pool不可以为空。', + ], + [ + 'errorCode' => 'OperationDenied.PoolRegionNotSupportAddPoolCidr', + 'errorMessage' => 'The operation is not allowed because pool region does not support adding CIDR.', + 'description' => '操作被拒绝，因为无法在该地域执行添加地址池CIDR的操作。', + ], + [ + 'errorCode' => 'OperationDenied.CidrConflictWithTopCidrs', + 'errorMessage' => 'The operation is not allowed because the input CIDR conflicts with existing top CIDRs.', + 'description' => '操作被拒绝，因为输入的CIDR与已存在的顶级池CIDR冲突。', + ], + [ + 'errorCode' => 'OperationDenied.SourceCidrIsNull', + 'errorMessage' => 'The operation is not allowed because the source CIDR is null.', + 'description' => '操作被拒绝，因为父地址池没有CIDR.', + ], + [ + 'errorCode' => 'OperationDenied.CidrNotInSourceCidr', + 'errorMessage' => 'The operation is not allowed because the input CIDR is not in source CIDR.', + 'description' => '操作被拒绝，因为输入的CIDR不在父池CIDR的范围内。', + ], + [ + 'errorCode' => 'ResourceNotFound.SourceIpamPool', + 'errorMessage' => 'The dependent source IPAM pool is not found.', + 'description' => '依赖资源源IPAM Pool不存在。', + ], + [ + 'errorCode' => 'OperationDenied.CidrConflictWithExistAllocation', + 'errorMessage' => 'The operation is not allowed because the input CIDR conflicts with the existing allocation.', + 'description' => '操作被拒绝，因为输入的CIDR与已分配的CIDR冲突。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'IllegalParam.Cidr', + 'errorMessage' => 'The specified CIDR is illegal.', + 'description' => '指定的CIDR不合法。', + ], + [ + 'errorCode' => 'QuotaExceeded.IpamCidrQuotaPerIpamPool', + 'errorMessage' => 'The quota of ipamCidrQuotaPerIpamPool count is exceeded.', + 'description' => 'IPAM地址池允许的CIDR数量超过限制。', + ], + [ + 'errorCode' => 'OperationDenied.OperateShareResource', + 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', + 'description' => '该实例是共享资源，不允许操作。', + ], + [ + 'errorCode' => 'IncorrectStatus.IpamPool', + 'errorMessage' => 'The status of the IPAM pool is incorrect.', + 'description' => 'IPAM地址池的状态不正确。', + ], + [ + 'errorCode' => 'MissingParam.CidrOrNetmaskLength', + 'errorMessage' => 'The Cidr or NetmaskLength must be input.', + 'description' => '为IPAM地址池预置地址段时，请输入Cidr或NetmaskLength。', + ], + [ + 'errorCode' => 'Mismatch.CidrAndPoolIpVersion', + 'errorMessage' => 'The ip verion of input Cidr is inconsistent with that of the input IPAM pool.', + 'description' => '输入的Cidr的IP地址协议版本与输入的IPAM地址池的IP地址协议版本不一致。', + ], + [ + 'errorCode' => 'Mismatch.CidrAndNetmaskLength', + 'errorMessage' => 'The mask of the input Cidr is inconsistent with the input NetmaskLength.', + 'description' => '输入的Cidr的掩码值和输入的NetmaskLength不一致。', + ], + [ + 'errorCode' => 'MissingParam.Cidr', + 'errorMessage' => 'The Cidr must be input when adding CIDR for IPAM private top pool.', + 'description' => '为IPAM私网顶级池预置地址段时，请输入Cidr。', + ], + [ + 'errorCode' => 'UnsupportedFeature.AddCidrForIpamPrivateIpv6Pool', + 'errorMessage' => 'Adding CIDR for IPAM private IPv6 pool is not supported for this user.', + 'description' => '当前用户不支持为IPAM私网IPv6地址池预置地址段。', + ], + [ + 'errorCode' => 'UnsupportedFeature.AddUlaCidrForIpamPublicIpv6Pool', + 'errorMessage' => 'Adding ULA CIDR for IPAM public IPv6 pool is not supported.', + 'description' => '不允许为IPAM公网IPv6地址池预置ULA地址段。', + ], + [ + 'errorCode' => 'IllegalParam.NetmaskLength', + 'errorMessage' => 'The specified NetmaskLength is illegal.', + 'description' => 'NetmaskLength参数不合法。', + ], + [ + 'errorCode' => 'OperationDenied.CidrConflictWithOfficialGuaCidrs', + 'errorMessage' => 'The operation is not allowed because the input CIDR conflicts with official GUA CIDRs.', + 'description' => '操作被拒绝，因为输入的CIDR与官方GUA CIDR冲突。', + ], + [ + 'errorCode' => 'OperationDenied.CidrUnavailableInPool', + 'errorMessage' => 'The operation is not allowed because the CIDR is unavailable in the IPAM pool.', + 'description' => '操作被拒绝，原因是CIDR在IPAM地址池中不可用。', + ], + [ + 'errorCode' => 'OperationDenied.AvailableCidrInsufficient', + 'errorMessage' => 'The operation is not allowed because available CIDR is insufficient.', + 'description' => '操作被拒绝，原因是可用的CIDR资源不足。', + ], + [ + 'errorCode' => 'OperationDenied.OfficialCidrInsufficient', + 'errorMessage' => 'The operation is not allowed because the official CIDR is insufficient.', + 'description' => '操作被拒绝，原因是官方可用的CIDR资源不足。', + ], + [ + 'errorCode' => 'OperationDenied.OfficialCidrUnavailable', + 'errorMessage' => 'The operation is not allowed because the official CIDR is unavailable.', + 'description' => '操作被拒绝，原因是CIDR已被占用。', + ], + [ + 'errorCode' => 'OperationDenied.OfficialCidrTmpUnavailable', + 'errorMessage' => 'The operation is not allowed because the official CIDR is temporarily unavailable.', + 'description' => '操作被拒绝，原因是官方CIDR资源暂时不可用。', + ], + [ + 'errorCode' => 'UnsupportedFeature.AddUlaCidrForIpamPrivateIpv6Pool', + 'errorMessage' => 'Adding ULA CIDR for IPAM private IPv6 pool is not supported for this user.', + 'description' => '', + ], + [ + 'errorCode' => 'UnsupportedFeature.AddByoipCidrForIpamPrivateIpv6Pool', + 'errorMessage' => 'Adding BYOIP CIDR for IPAM private IPv6 pool is not supported for this user.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + ], + ], + 'title' => '为IPAM地址池预置CIDR地址段', + 'summary' => '为IPAM地址池预置CIDR地址段。', + 'description' => '- 预置CIDR前，请确保您已经创建了IPAM地址池。您可以通过调用**CreateIpamPool**创建地址池。'."\n" + .'- 若父地址池没有预置CIDR，则子地址池不支持预置CIDR。'."\n" + .'- 若父地址池预置了CIDR，则子地址池可以预置CIDR且预置的CIDR必须是父地址池预置CIDR的子集。'."\n" + .'- 若父地址池预置了CIDR同时也创建了CIDR分配，则子地址池预置的CIDR不能和已创建的CIDR分配冲突。'."\n" + .'- 为地址池预置CIDR地址段的请求需要从IPAM托管地域发起。'."\n" + .'- 为IPAM地址池预置的CIDR不能和相同作用范围内其他地址池预置的CIDR冲突。'."\n" + .'- 地址池预置CIDR的数量存在限制，公网IPv6顶级池默认最多为1个，其余类型的地址池默认最多为50个。', + 'changeSet' => [ + [ + 'createdAt' => '2025-05-16T06:50:59.000Z', + 'description' => 'OpenAPI 下线', + ], + [ + 'createdAt' => '2025-04-29T06:52:08.000Z', + 'description' => 'OpenAPI 下线', + ], + [ + 'createdAt' => '2025-04-29T06:51:34.000Z', + 'description' => 'OpenAPI 下线', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'AddIpamPoolCidr', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:AddIpamPoolCidr', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"558BC336-8B88-53B0-B4AD-980EE900AB01\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\"\\n}","type":"json"}]', + ], + 'AssociateIpamResourceDiscovery' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会关联资源发现和IPAM实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并关联资源发现和IPAM实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamCreateModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E897D16A-50EB-543F-B002-C5A26AB818FF', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'ResourceNotFound.IpamResourceDiscovery', + 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', + 'description' => '未找到IPAM资源发现实例。', + ], + [ + 'errorCode' => 'ResourceNotFound.Ipam', + 'errorMessage' => 'The specified resource of ipam is not found.', + 'description' => '输入的IPAM不存在。', + ], + [ + 'errorCode' => 'OperationDenied.ResourceDiscoveryAlreadyAssociated', + 'errorMessage' => 'You cannot associate the resource discovery because an association already exists.', + 'description' => '当前资源发现已存在关联关系，操作失败。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '关联资源发现和IPAM实例', + 'summary' => '关联资源发现和IPAM实例。', + 'description' => '- 指定的资源发现实例和IPAM实例只能存在一个关联关系，不能重复进行关联。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'AssociateIpamResourceDiscovery', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:AssociateIpamResourceDiscovery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamResourceDiscovery', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamresourcediscovery/{#IpamResourceDiscoveryId}', + ], + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'Ipam', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E897D16A-50EB-543F-B002-C5A26AB818FF\\"\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改资源组的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-uq5dcfc2eqhpf4****', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '新资源组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aek3ctkufaw****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型，取值：'."\n" + ."\n" + .'- Ipam：IPAM实例'."\n" + ."\n" + .'- IpamScope：IPAM作用范围'."\n" + ."\n" + .'- IpamPool：IPAM地址池'."\n" + ."\n" + .'- IpamResourceDiscovery：IPAM资源发现', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Ipam' => 'Ipam', + 'IpamPool' => 'IpamPool', + 'IpamScope' => 'IpamScope', + 'IpamResourceDiscovery' => 'IpamResourceDiscovery', + ], + 'example' => 'Ipam', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam.ResourceGroupId', + 'errorMessage' => 'The input parameter ResourceGroupId is invalid.', + 'description' => '参数ResourceGroupId非法。'."\n", + ], + [ + 'errorCode' => 'IllegalParam.ResourceType', + 'errorMessage' => 'The input parameter ResourceType is invalid.', + 'description' => '参数ResourceType非法。'."\n", + ], + [ + 'errorCode' => 'ResourceNotFound.Ipam', + 'errorMessage' => 'The specified resource of ipam is not found.', + 'description' => '输入的IPAM不存在。', + ], + ], + ], + 'title' => '修改IPAM资源所属的资源组', + 'summary' => '修改IPAM资源所属的资源组。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ChangeResourceGroup', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'Ipam', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\"\\n}","type":"json"}]', + ], + 'CreateIpam' => [ + 'summary' => '创建一个IPAM实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'OperatingRegionList', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IPAM生效地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM的生效地域。'."\n" + ."\n" + .'> 支持选择一个或多个地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'IpamDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的描述信息。'."\n" + ."\n" + .'长度为1～256个字符，必须以大小写字母或中文开头，但不能以` http:// `和` https:// `开头。描述不填则为空，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is my first Ipam', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxazb4ph6aiy****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会创建IPAM。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建IPAM。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '资源的标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamCreateModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0ED8D006-F706-4D23-88ED-E11ED39DCAC0', + ], + 'IpamId' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + 'PrivateDefaultScopeId' => [ + 'description' => '创建IPAM后，系统默认创建的私网IPAM作用范围。', + 'type' => 'string', + 'example' => 'ipam-scope-8wiontzmiy6cg0****', + ], + 'PublicDefaultScopeId' => [ + 'description' => '创建IPAM后，系统默认创建的公网IPAM作用范围。', + 'type' => 'string', + 'example' => 'ipam-scope-r5c5c7bmym1brc****', + ], + 'DefaultResourceDiscoveryId' => [ + 'description' => '默认资源发现实例ID。', + 'type' => 'string', + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + 'DefaultResourceDiscoveryAssociationId' => [ + 'description' => '默认的资源发现关联关系ID。', + 'type' => 'string', + 'example' => 'ipam-res-disco-assoc-jt5fac8twugdbbgip****', + ], + 'ResourceDiscoveryAssociationCount' => [ + 'description' => '资源发现数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'UnsupportedRegion.Ipam', + 'errorMessage' => 'Ipam is not supported in this region.', + 'description' => '该地域不支持IPAM。', + ], + [ + 'errorCode' => 'QuotaExceeded.IpamQuotaPerRegion', + 'errorMessage' => 'The quota of ipamQuotaPerRegion count is exceeded.', + 'description' => 'IPAM允许的最大数量超过限制。', + ], + [ + 'errorCode' => 'IllegalParam.OperatingRegion', + 'errorMessage' => 'The operating region is invalid.', + 'description' => '生效地域非法。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationFailed.OperatingRegionsNeedIncludeIpamRegion', + 'errorMessage' => 'The operating regions do not contain IPAM region.', + 'description' => '操作地域未包含IPAM托管地域。', + ], + [ + 'errorCode' => 'UnsupportedFeature.Ipam', + 'errorMessage' => 'IPAM is not supported in this region.', + 'description' => '该地域不支持IPAM功能。', + ], + [ + 'errorCode' => 'OptInRequired.Ipam', + 'errorMessage' => 'You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.', + 'description' => '您无权使用请求的 IPAM 服务。 确保您已经订阅了您尝试使用的服务。', + ], + ], + ], + 'title' => '创建一个IPAM实例', + 'description' => '## 接口说明'."\n" + ."\n" + .'- 每个阿里云账号（主账号）在每个地域只支持创建1个IPAM。'."\n" + ."\n" + .'- 目前，IPAM仅支持分配IPv4类型的IP地址。'."\n" + ."\n" + .'- 创建IPAM实例时：'."\n" + .' - 若用户在当前地域不存在自定义类型的资源发现实例，系统会直接创建与IPAM实例关联的默认资源发现实例。'."\n" + .' - 若用户在当前地域已经存在自定义类型的资源发现实例，系统会将该资源发现转化为默认资源发现，并创建与IPAM实例的关联关系。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpam', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vpc:CreateIpam', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED39DCAC0\\",\\n \\"IpamId\\": \\"ipam-ccxbnsbhew0d6t****\\",\\n \\"PrivateDefaultScopeId\\": \\"ipam-scope-8wiontzmiy6cg0****\\",\\n \\"PublicDefaultScopeId\\": \\"ipam-scope-r5c5c7bmym1brc****\\",\\n \\"DefaultResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"DefaultResourceDiscoveryAssociationId\\": \\"ipam-res-disco-assoc-jt5fac8twugdbbgip****\\",\\n \\"ResourceDiscoveryAssociationCount\\": 1\\n}","type":"json"}]', + ], + 'CreateIpamPool' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamScopeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + ], + [ + 'name' => 'IpamPoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc', + ], + ], + [ + 'name' => 'IpamPoolDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的描述。'."\n" + ."\n" + .'长度为1～256个字符，必须以大小写英文字母或者中文字符开头，但不能以`http://`或`https://`开头。不填则为空，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxazb4ph6aiy****', + ], + ], + [ + 'name' => 'PoolRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池生效地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourceIpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => '源IPAM地址池的实例ID。'."\n" + ."\n" + .'> 不输入此参数时，表示创建的地址池为父地址池。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'AllocationDefaultCidrMask', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池分配的默认网络掩码。'."\n" + ."\n" + .'> IPv4网络掩码取值范围为**0~32**位，IPv6网络掩码取值范围为**0~128**位。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '28', + ], + ], + [ + 'name' => 'AllocationMaxCidrMask', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池分配的最大网络掩码。'."\n" + ."\n" + .'> IPv4网络掩码取值范围为**0~32**位，IPv6网络掩码取值范围为**0~128**位。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '32', + ], + ], + [ + 'name' => 'AllocationMinCidrMask', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池分配的最小网络掩码。'."\n" + ."\n" + .'> IPv4网络掩码取值范围为**0~32**位，IPv6网络掩码取值范围为**0~128**位。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会创建IPAM地址池。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过，则返回对应错误。如果检查通过，则返回DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP地址协议版本。取值：'."\n" + ."\n" + .'- **IPv4**：IPv4协议。'."\n" + ."\n" + .'- **IPv6**：IPv6协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + [ + 'name' => 'Ipv6Isp', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPv6地址段类型，仅对公网IPv6地址池生效。取值：'."\n" + ."\n" + .'- **BGP**（默认值）：阿里云BGP IPv6。'."\n" + .'- **ChinaMobile**：中国移动（单线）。'."\n" + .'- **ChinaUnicom**：中国联通（单线）。'."\n" + .'- **ChinaTelecom**：中国电信（单线）。'."\n" + ."\n" + .'> 如果是开通了单线带宽白名单的用户，该字段可以设置为**ChinaTelecom**（中国电信）、**ChinaUnicom**（中国联通）或**ChinaMobile**（中国移动）。', + 'type' => 'string', + 'required' => false, + 'example' => 'BGP', + ], + ], + [ + 'name' => 'AutoImport', + 'in' => 'query', + 'schema' => [ + 'description' => '地址池是否开启自动导入功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。最多支持20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'> 参数**ResourceId.N**或**Tag.N**（**Tag.N.Key**与**Tag.N.Value**）至少输入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '资源的标签值。最多支持20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'> 参数**ResourceId.N**或**Tag.N**（**Tag.N.Key**与**Tag.N.Value**）至少输入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamPoolCreateModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', + ], + 'IpamPoolId' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamScope', + 'errorMessage' => 'The specified resource of IPAM scope is not found.', + 'description' => '输入的IPAM作用范围不存在。', + ], + [ + 'errorCode' => 'ResourceNotFound.SourceIpamPool', + 'errorMessage' => 'The dependent source IPAM pool is not found.', + 'description' => '依赖资源源IPAM Pool不存在。', + ], + [ + 'errorCode' => 'UnsupportedFeature.PublicIpamScopeType', + 'errorMessage' => 'The feature of PublicIpamScopeType is not supported.', + 'description' => '您指定的IPAM暂不支持创建Public类型的作用范围。', + ], + [ + 'errorCode' => 'IllegalParam.AllocationDefaultNetmask', + 'errorMessage' => 'The specified AllocationDefaultNetmask is illegal.', + 'description' => 'AllocationDefaultNetmask参数不合法。'."\n", + ], + [ + 'errorCode' => 'IllegalParam.AllocationMaxNetmask', + 'errorMessage' => 'The specified AllocationMaxNetmask is illegal.', + 'description' => 'AllocationMaxNetmask参数不合法。'."\n", + ], + [ + 'errorCode' => 'IllegalParam.AllocationMinNetmask', + 'errorMessage' => 'The specified AllocationMinNetmask is illegal.', + 'description' => 'AllocationMinNetmask参数不合法。'."\n", + ], + [ + 'errorCode' => 'IllegalParam.IpVersion', + 'errorMessage' => 'The specified IpVersion is illegal.', + 'description' => 'IpVersion参数不合法。'."\n", + ], + [ + 'errorCode' => 'QuotaExceeded.IpamPoolQuotaDepth', + 'errorMessage' => 'The quota of IpamPoolQuotaDepth count is exceeded.', + 'description' => 'IPAM地址池深度允许的最大数量超过限制。'."\n", + ], + [ + 'errorCode' => 'ResourceNotFound.Ipam', + 'errorMessage' => 'The specified resource of ipam is not found.', + 'description' => '输入的IPAM不存在。', + ], + [ + 'errorCode' => 'IllegalParam.PoolRegionId', + 'errorMessage' => 'The specified PoolRegionId is illegal.', + 'description' => 'PoolRegionId参数不合法。'."\n", + ], + [ + 'errorCode' => 'QuotaExceeded.IpamSubPoolQuotaPerIpamPool', + 'errorMessage' => 'The quota of ipamSubPoolQuotaPerIpamPool count is exceeded.', + 'description' => '单个IPAM地址池允许创建的子池数量超过限额。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'IncorrectStatus.IpamPool', + 'errorMessage' => 'The status of the IPAM pool is incorrect.', + 'description' => 'IPAM地址池的状态不正确。', + ], + [ + 'errorCode' => 'OperationDenied.OperateShareResource', + 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', + 'description' => '该实例是共享资源，不允许操作。', + ], + [ + 'errorCode' => 'UnsupportedFeature.IpamPublicIpv4Pool', + 'errorMessage' => 'The feature of public IPv4 pool is not supported in IPAM.', + 'description' => 'IPAM暂不支持创建公网IPv4地址池。', + ], + [ + 'errorCode' => 'OperationDenied.IpamPublicIpv6PoolNeedPoolRegion', + 'errorMessage' => 'The public IPv6 pool cannot be created in IPAM when its pool region is empty.', + 'description' => '不支持创建生效地域为空的公网IPv6地址池。', + ], + [ + 'errorCode' => 'IllegalParam.Ipv6Isp', + 'errorMessage' => 'The specified Ipv6Isp is illegal.', + 'description' => '指定的Ipv6Isp参数不合法。', + ], + [ + 'errorCode' => 'UnsupportedFeature.Ipv6Isp', + 'errorMessage' => 'The Ipv6Isp feature is not supported.', + 'description' => '指定的Ipv6Isp特性不支持。', + ], + [ + 'errorCode' => 'UnsupportedRegion.Ipv6Isp', + 'errorMessage' => 'The current region does not support this feature.', + 'description' => '当前Region未支持该特性。', + ], + [ + 'errorCode' => 'QuotaExceeded.IpamPublicIpv6TopPoolQuotaPerRegionIsp', + 'errorMessage' => 'The number of public IPv6 top pool in IPAM for this ISP owned by the user in this region exceeds the limit.', + 'description' => '对于当前的ISP类型，用户在当前地域创建的IPAM公网IPv6顶级地址池数量超过限额。', + ], + [ + 'errorCode' => 'Mismatch.IpamScopeAndSourceIpamPool', + 'errorMessage' => 'The input source IPAM pool is not in the input IPAM scope.', + 'description' => '输入的IPAM父池不在输入的IPAM作用范围内。', + ], + [ + 'errorCode' => 'Mismatch.Ipv6IspAndSourceIpamPool', + 'errorMessage' => 'The input Ipv6Isp is inconsistent with the Ipv6Isp of the input source IPAM pool.', + 'description' => '输入的Ipv6Isp和父池的Ipv6Isp不一致。', + ], + [ + 'errorCode' => 'UnsupportedFeature.IpamIpv6', + 'errorMessage' => 'The feature of IPv6 is not supported in this region.', + 'description' => '该地域不支持在IPAM中使用IPv6功能。', + ], + ], + ], + 'title' => '创建IPAM地址池', + 'summary' => '创建IPAM地址池。', + 'description' => '- 每个地域每种ISP类型的公网IPv6顶级池的数量默认最多为1个。', + 'changeSet' => [ + [ + 'createdAt' => '2025-05-16T06:50:59.000Z', + 'description' => 'OpenAPI 下线', + ], + [ + 'createdAt' => '2025-04-29T06:52:08.000Z', + 'description' => 'OpenAPI 下线', + ], + [ + 'createdAt' => '2025-04-29T06:51:34.000Z', + 'description' => 'OpenAPI 下线', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpamPool', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vpc:CreateIpamPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamPool', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\"\\n}","type":"json"}]', + ], + 'CreateIpamPoolAllocation' => [ + 'summary' => '从IPAM地址池创建自定义预留网段。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要创建的自定义预留网段所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'Cidr', + 'in' => 'query', + 'schema' => [ + 'description' => '通过输入地址段的方式从IPAM地址池创建自定义预留网段。'."\n" + ."\n" + .'>参数**Cidr**或**CidrMask**至少输入一个。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.0/24', + ], + ], + [ + 'name' => 'CidrMask', + 'in' => 'query', + 'schema' => [ + 'description' => '通过输入掩码的方式从IPAM地址池创建自定义预留网段。'."\n" + ."\n" + .'>参数**Cidr**或**CidrMask**至少输入一个。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '24', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会创建自定义预留网段。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接创建。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'IpamPoolAllocationDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义预留网段的描述信息。'."\n" + ."\n" + .'长度为1～256个字符，必须以大小写英文字母或中文字符开头，但不能以`http://`或`https://`开头。不填则为空，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'IpamPoolAllocationName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义预留网段的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamPoolAllocationCreateModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2', + ], + 'IpamPoolAllocationId' => [ + 'description' => '创建的自定义预留网段的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-alloc-112za33e4****', + ], + 'Cidr' => [ + 'description' => '创建的自定义预留网段。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + 'SourceCidr' => [ + 'description' => '源地址段。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.ResourceTypeIsNotCustom', + 'errorMessage' => 'The operation is not allowed because the resource type is not Custom.', + 'description' => '操作被拒绝，原因是资源类型不是Custom类型。', + ], + [ + 'errorCode' => 'MissingParam.CidrOrCidrMask', + 'errorMessage' => 'The CIDR or CIDR Mask must be input.', + 'description' => '从IPAM地址池分配资源或查询可用资源时，请输入Cidr或CidrMask。', + ], + [ + 'errorCode' => 'OperationDenied.IpamPoolNotInRegion', + 'errorMessage' => 'The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.', + 'description' => '操作被拒绝，因为无法从不具备地域属性的地址池中创建VPC或为VPC添加附加网段。', + ], + [ + 'errorCode' => 'OperationDenied.RequestRegionInvalid', + 'errorMessage' => 'The operation is not allowed because the request is not invoked in the region of the IPAM pool.', + 'description' => '操作被拒绝，因为未在地址池所在地域调用请求。', + ], + [ + 'errorCode' => 'IllegalParam.Cidr', + 'errorMessage' => 'The specified CIDR is illegal.', + 'description' => '指定的CIDR不合法。', + ], + [ + 'errorCode' => 'IllegalParam.CidrMask', + 'errorMessage' => 'The specified CidrMask is illegal.', + 'description' => 'CidrMask参数不合法。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.AvailableCidrInsufficient', + 'errorMessage' => 'The operation is not allowed because available CIDR is insufficient.', + 'description' => '操作被拒绝，原因是可用的CIDR资源不足。', + ], + [ + 'errorCode' => 'OperationDenied.CidrInExcludeCidrs', + 'errorMessage' => 'The operation is not allowed because the input CIDR is within the illegal CIDRs.', + 'description' => '操作被拒绝，原因是输入的CIDR在不合法的CIDR范围内。', + ], + [ + 'errorCode' => 'OperationDenied.CidrUnavailableInPool', + 'errorMessage' => 'The operation is not allowed because the CIDR is unavailable in the IPAM pool.', + 'description' => '操作被拒绝，原因是CIDR在IPAM地址池中不可用。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2\\",\\n \\"IpamPoolAllocationId\\": \\"ipam-pool-alloc-112za33e4****\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"SourceCidr\\": \\"192.168.0.0/16\\"\\n}","type":"json"}]', + 'title' => '从IPAM地址池创建自定义预留网段', + 'description' => '- 创建自定义预留网段前，请确保您已经创建了IPAM地址池并为该地址池添加了CIDR。您可以通过调用**CreateIpamPool**和**AddIpamPoolCidr**分别创建IPAM地址池并为地址池添加CIDR。'."\n" + .'- 指定参数Cidr或CidrMask创建自定义预留网段时，对应的掩码需要在IPAM地址池规定的范围内。'."\n" + .'- 当IPAM地址池具备地域属性时，创建自定义预留网段的请求需要从地址池所在的地域发起。'."\n" + .'- 需要创建的自定义预留网段不能和IPAM地址池已创建的CIDR分配冲突。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpamPoolAllocation', + ], + ], + ], + 'ramActions' => [], + ], + 'CreateIpamResourceDiscovery' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求地域。'."\n" + ."\n" + .'> 创建时的请求地域是资源发现实例的托管地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + ], + [ + 'name' => 'OperatingRegionList', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源发现的生效地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源发现的生效地域。'."\n" + ."\n" + .'> 需要包括创建时的请求地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2sermdd6****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会创建自定义类型的资源发现实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并创建自定义类型的资源发现实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '资源的标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamCreateModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', + ], + 'IpamResourceDiscoveryId' => [ + 'description' => '资源发现的实例ID。', + 'type' => 'string', + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam.OperatingRegion', + 'errorMessage' => 'The operating region is invalid.', + 'description' => '生效地域非法。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.OperatingRegionsNeedIncludeHomeRegion', + 'errorMessage' => 'The operating regions do not contain home region.', + 'description' => '生效地域未包含中心托管地域。', + ], + [ + 'errorCode' => 'QuotaExceeded.IpamResourceDiscoveryQuotaPerRegion', + 'errorMessage' => 'The number of non-shared IPAM resource discoveries owned by the user in this region exceeds the limit.', + 'description' => '单个用户在当前地域拥有的非共享资源发现的数量超过限额。', + ], + [ + 'errorCode' => 'OperationDenied.UnexpectedType', + 'errorMessage' => 'The operation is not allowed because the input type is unexpected.', + 'description' => '更新或删除资源发现时，不允许操作system类型的实例。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '创建自定义类型的资源发现实例', + 'summary' => '创建自定义类型的资源发现实例。', + 'description' => '- 每个阿里云账号（主账号）在每个地域只支持拥有1个资源发现实例。'."\n" + ."\n" + .'- 该接口只支持创建自定义类型的资源发现实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpamResourceDiscovery', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vpc:CreateIpamResourceDiscovery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamResourceDiscovery', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamresourcediscovery/*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\",\\n \\"IpamResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\"\\n}","type":"json"}]', + ], + 'CreateIpamScope' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + ], + [ + 'name' => 'IpamScopeName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpamScopeDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围的描述信息。'."\n" + ."\n" + .'长度为1～256个字符，必须以英文大小写字母开头，但不能以`http://`或`https://`开头。不填则为空，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxazb4ph6aiy****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求，取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会创建IPAM作用范围。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过，则返回对应错误。如果检查通过，会返回错误码`DryRunOperation`。'."\n" + ."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回2xx HTTP状态码并创建IPAM作用范围。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'IpamScopeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围类型：'."\n" + .'**private**。'."\n" + ."\n\n" + .'> 当前只支持创建私网作用范围。', + 'type' => 'string', + 'required' => false, + 'example' => 'private', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。最多支持20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '资源的标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamScopeCreateModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E897D16A-50EB-543F-B002-C5A26AB818FF', + ], + 'IpamScopeId' => [ + 'description' => 'IPAM作用范围的实例ID。', + 'type' => 'string', + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotFound.Ipam', + 'errorMessage' => 'The specified resource of ipam is not found.', + 'description' => '输入的IPAM不存在。', + ], + [ + 'errorCode' => 'UnsupportedFeature.PublicIpamScopeType', + 'errorMessage' => 'The feature of PublicIpamScopeType is not supported.', + 'description' => '您指定的IPAM暂不支持创建Public类型的作用范围。', + ], + [ + 'errorCode' => 'QuotaExceeded.IpamScopeQuotaPerIpam', + 'errorMessage' => 'The quota of ipamScopeQuotaPerIpam count is exceeded.', + 'description' => 'IPAM作用范围允许的最大数量超过限制。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + ], + ], + 'title' => '创建IPAM作用范围', + 'summary' => '创建私网和公网IPAM作用范围，分别用于管理私网和公网地址。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpamScope', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vpc:CreateIpamScope', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E897D16A-50EB-543F-B002-C5A26AB818FF\\",\\n \\"IpamScopeId\\": \\"ipam-scope-glfmcyldpm8lsy****\\"\\n}","type":"json"}]', + ], + 'DeleteIpam' => [ + 'summary' => '删除IPAM实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会删除IPAM。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接删除IPAM。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '30A20EE2-6223-5D0F-BF49-D7C78F206063', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotFound.Ipam', + 'errorMessage' => 'The specified resource of ipam is not found.', + 'description' => '输入的IPAM不存在。', + ], + [ + 'errorCode' => 'OperationFailed.IpamScopeExist', + 'errorMessage' => 'The operation is failed because user IPAM scope exist.', + 'description' => '操作失败，原因是存在用户自定义scope。', + ], + [ + 'errorCode' => 'OperationFailed.IpamPoolExist', + 'errorMessage' => 'The operation is failed because user IPAM pool exist.', + 'description' => '操作失败，原因是IPAM存在用户创建地址池。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.SharedResourceDiscoveryAssociated', + 'errorMessage' => 'The operation is not allowed because the IPAM is associated with a shared resource discovery.', + 'description' => '无法删除IPAM，原因是该IPAM关联了共享的资源发现。', + ], + [ + 'errorCode' => 'DependencyViolation.ShareResource', + 'errorMessage' => 'The operation is not allowed because the default resource discovery of this IPAM is sharing.', + 'description' => '无法删除IPAM，原因是该IPAM的默认资源发现存在共享关系。', + ], + [ + 'errorCode' => 'DependencyViolation.IpamMembers', + 'errorMessage' => 'The IPAM [%s] has managed members [%s], so the IPAM cannot be deleted.', + 'description' => 'IPAM[%s]存在纳管成员[%s]，此IPAM不允许删除。', + ], + ], + ], + 'title' => '删除一个IPAM实例', + 'description' => '## 前提条件'."\n" + ."\n" + .'- 删除IPAM前，请确保该IPAM下的地址池已全部删除。您可以通过调用**DeleteIpamPool**接口删除地址池。'."\n" + .'- 删除IPAM前，请确保该IPAM下新创建的IPAM作用范围已全部删除。您可以通过调用**DeleteIpamScope**接口删除IPAM作用范围。'."\n" + ."\n" + .'- 删除IPAM前，请确保该IPAM下的默认资源发现实例不存在共享关系。'."\n" + .'- 删除IPAM前，请确保没有共享的资源发现实例关联到该IPAM实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpam', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vpc:DeleteIpam', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30A20EE2-6223-5D0F-BF49-D7C78F206063\\"\\n}","type":"json"}]', + ], + 'DeleteIpamPool' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会删除IPAM地址池实例。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过，则返回对应错误。如果检查通过，则返回DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '57B7DCCA-F192-5528-8AF3-2FE1413228C9', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.PoolRegionNotSupportDeletePool', + 'errorMessage' => 'The operation is not allowed because of pool region not support delete.', + 'description' => '操作被拒绝，原因是无法在该地域执行删除地址池操作。'."\n", + ], + [ + 'errorCode' => 'DependencyViolation.SubCidr', + 'errorMessage' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', + 'description' => '指定的资源被其他的资源依赖，不允许进行当前操作。'."\n", + ], + [ + 'errorCode' => 'DependencyViolation.CustomCidrs', + 'errorMessage' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', + 'description' => '指定的资源被其他的资源依赖，不允许进行当前操作。'."\n", + ], + [ + 'errorCode' => 'Forbidden.SubPool', + 'errorMessage' => 'The IPAM pool contains subpools.', + 'description' => 'IPAM地址池中含有子池，不允许删除。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.OperateShareResource', + 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', + 'description' => '该实例是共享资源，不允许操作。', + ], + [ + 'errorCode' => 'IncorrectStatus.IpamPool', + 'errorMessage' => 'The status of the IPAM pool is incorrect.', + 'description' => 'IPAM地址池的状态不正确。', + ], + [ + 'errorCode' => 'DependencyViolation.ShareResource', + 'errorMessage' => 'The specified resource of IPAM pool depends on resource sharing, so the operation cannot be completed.', + 'description' => 'IPAM地址池存在共享关系，无法完成当前操作。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + ], + ], + 'title' => '删除IPAM地址池实例', + 'summary' => '删除IPAM地址池实例。', + 'description' => '### 使用说明'."\n" + ."\n" + .'- 删除父地址池前，请确保父地址池下的子地址池已全部被删除。'."\n" + .'- 当父地址池设置了生效地域，且该父地址池有已经分配出去的地址时，该父地址池不允许被删除。'."\n" + .'- 当子地址池设置了生效地域，且该地址池有已经分配出去的地址时，该子地址池不允许被删除。'."\n" + ."\n" + .'- 当地址池存在共享关系时，该地址池不允许被删除。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamPool', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vpc:DeleteIpamPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"57B7DCCA-F192-5528-8AF3-2FE1413228C9\\"\\n}","type":"json"}]', + ], + 'DeleteIpamPoolAllocation' => [ + 'summary' => '释放IPAM地址池的CIDR分配，当前支持的类型包括专有网络、自定义分配。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要释放的CIDR分配所在的地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolAllocationId', + 'in' => 'query', + 'schema' => [ + 'description' => '要释放的CIDR分配的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-alloc-c4vhvr3b22mmc6****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会释放IPAM地址池的CIDR分配。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接释放CIDR分配。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B90776C8-F703-51D5-893A-AD1CA699D535', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.ResourceTypeIsNotCustom', + 'errorMessage' => 'The operation is not allowed because the resource type is not Custom.', + 'description' => '操作被拒绝，原因是资源类型不是Custom类型。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'ResourceNotFound.IpamPoolAllocation', + 'errorMessage' => 'The specified resource of IPAM pool allocation is not found.', + 'description' => '输入的IPAM地址池分配关系不存在。', + ], + [ + 'errorCode' => 'OperationDenied.UnexpectedResourceType', + 'errorMessage' => 'The operation is not allowed because the resource type is unexpected.', + 'description' => '资源类型非法，不允许操作。', + ], + [ + 'errorCode' => 'OperationDenied.Unauthorized', + 'errorMessage' => 'The operation is denied because the user is not authorized.', + 'description' => '操作失败，用户无权限。', + ], + [ + 'errorCode' => 'OperationDenied.RequestRegionInvalid', + 'errorMessage' => 'The operation is not allowed because the request is not invoked in the region of the IPAM pool.', + 'description' => '操作被拒绝，因为未在地址池所在地域调用请求。', + ], + [ + 'errorCode' => 'OperationDenied.Ipv6VpcNotSupport', + 'errorMessage' => 'The allocation of IPv6 VPC is not supported to delete.', + 'description' => 'IPv6网段类型的分配不支持释放。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B90776C8-F703-51D5-893A-AD1CA699D535\\"\\n}","type":"json"}]', + 'title' => '释放IPAM地址池的CIDR分配', + 'changeSet' => [ + [ + 'createdAt' => '2025-05-16T06:50:59.000Z', + 'description' => 'OpenAPI 下线', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamPoolAllocation', + ], + ], + ], + 'ramActions' => [], + ], + 'DeleteIpamPoolCidr' => [ + 'summary' => '删除IPAM地址池预置的CIDR地址段。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'Cidr', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的预置的CIDR地址段。'."\n" + ."\n" + .'> 目前，只支持IPv4类型的地址段。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.1.0/24', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会删除IPAM地址池中的CIDR地址段。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接删除。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F28A239E-F88D-500E-ADE7-FA5E8CA3A170', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPoolCidr', + 'errorMessage' => 'The specified resource of IPAM pool CIDR is not found.', + 'description' => '输入的IPAM地址池CIDR不存在。', + ], + [ + 'errorCode' => 'OperationDenied.PoolRegionNotSupportDeletePoolCidr', + 'errorMessage' => 'The operation is not allowed because pool region does not support deleting cidr.', + 'description' => '操作被拒绝，原因是无法在该地域执行删除地址池CIDR操作。', + ], + [ + 'errorCode' => 'OperationDenied.IpamPoolAllocationExist', + 'errorMessage' => 'The operation is not allowed because of the existence of IPAM pool allocation.', + 'description' => '操作被拒绝，原因是存在地址池分配关系。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.OperateShareResource', + 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', + 'description' => '该实例是共享资源，不允许操作。', + ], + [ + 'errorCode' => 'IncorrectStatus.IpamPool', + 'errorMessage' => 'The status of the IPAM pool is incorrect.', + 'description' => 'IPAM地址池的状态不正确。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F28A239E-F88D-500E-ADE7-FA5E8CA3A170\\"\\n}","type":"json"}]', + 'title' => '删除IPAM地址池预置的CIDR地址段', + 'description' => '- 若父地址池和子地址池下均预置了CIDR，则删除CIDR时，需要先删除子地址池下的CIDR后再删除父地址池下的CIDR。'."\n" + .'- 若只有父地址池下预置了CIDR，则删除CIDR时直接删除父地址池下的CIDR即可。'."\n" + .'- 若预置的CIDR下存在已经创建的分配关系，删除CIDR时需要先删除已创建的CIDR分配，然后再删除CIDR。'."\n" + .'- 删除IPAM地址池预置的CIDR地址段的请求需要从IPAM托管地域发起。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamPoolCidr', + ], + ], + ], + 'ramActions' => [], + ], + 'DeleteIpamResourceDiscovery' => [ + 'summary' => '删除自定义类型的资源发现实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会删除资源发现实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并删除资源发现实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamCreateModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9F8315CB-560E-5F1E-B069-6E44B440CAF8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.OperateShareResource', + 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', + 'description' => '该实例是共享资源，不允许操作。', + ], + [ + 'errorCode' => 'ResourceNotFound.IpamResourceDiscovery', + 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', + 'description' => '未找到IPAM资源发现实例。', + ], + [ + 'errorCode' => 'OperationDenied.UnexpectedType', + 'errorMessage' => 'The operation is not allowed because the input type is unexpected.', + 'description' => '更新或删除资源发现时，不允许操作system类型的实例。', + ], + [ + 'errorCode' => 'DependencyViolation.ShareResource', + 'errorMessage' => 'The specified resource of IPAM resource discovery depends on resource sharing, so the operation cannot be completed.', + 'description' => 'IPAM资源发现存在共享关系，无法完成当前操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '删除自定义类型的资源发现实例', + 'description' => '- 当资源发现实例存在共享关系时，该资源发现不允许被删除。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamResourceDiscovery', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vpc:DeleteIpamResourceDiscovery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamResourceDiscovery', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamresourcediscovery/{#IpamResourceDiscoveryId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F8315CB-560E-5F1E-B069-6E44B440CAF8\\"\\n}","type":"json"}]', + ], + 'DeleteIpamScope' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamScopeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + .'- **true**：发送检查请求，不会删除IPAM作用范围。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行操作。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '88144bdb-b190-4813-a3f5-66cc86694162', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9F8315CB-560E-5F1E-B069-6E44B440CAF8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamScope', + 'errorMessage' => 'The specified resource of IPAM scope is not found.', + 'description' => '输入的IPAM作用范围不存在。', + ], + [ + 'errorCode' => 'IncorrectStatus.IpamScope', + 'errorMessage' => 'The status of the IPAM scope is incorrect.', + 'description' => 'IPAM作用范围的状态不正确。'."\n", + ], + [ + 'errorCode' => 'OperationDenied.DeleteDefaultScope', + 'errorMessage' => 'The operation is not allowed because of deleting default scope.', + 'description' => '操作被拒绝，原因是删除默认IPAM作用范围。', + ], + [ + 'errorCode' => 'OperationFailed.IpamPoolExist', + 'errorMessage' => 'The operation is failed because user IPAM pool exist.', + 'description' => '操作失败，原因是IPAM存在用户创建地址池。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + ], + ], + 'title' => '删除IPAM作用范围', + 'summary' => '删除IPAM作用范围。', + 'description' => '### 使用说明'."\n" + ."\n" + .'- 删除IPAM作用范围时，系统默认创建的两个IPAM作用范围无法删除。'."\n" + ."\n" + .'- 删除新建的IPAM作用范围前，请确保该IPAM作用范围的地址池已全部删除。您可以调用**DeleteIpamPool**删除地址池。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamScope', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'vpc:DeleteIpamScope', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamScope', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F8315CB-560E-5F1E-B069-6E44B440CAF8\\"\\n}","type":"json"}]', + ], + 'DissociateIpamResourceDiscovery' => [ + 'summary' => '解关联资源发现和IPAM实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会解关联资源发现和IPAM实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并解关联资源发现和IPAM实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamCreateModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '86137597-443F-5B66-B9B6-8514E0C50B8F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'ResourceNotFound.IpamResourceDiscovery', + 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', + 'description' => '未找到IPAM资源发现实例。', + ], + [ + 'errorCode' => 'ResourceNotFound.Ipam', + 'errorMessage' => 'The specified resource of ipam is not found.', + 'description' => '输入的IPAM不存在。', + ], + [ + 'errorCode' => 'ResourceNotFound.ResourceDiscoveryAssociation', + 'errorMessage' => 'You cannot disassociate from the resource discovery because no association exists.', + 'description' => '当前资源发现不存在关联关系，操作失败。', + ], + [ + 'errorCode' => 'OperationDenied.DissociateSelfSystemIpamResourceDiscovery', + 'errorMessage' => 'The operation is not allowed because the default resource discovery cannot be disassociated.', + 'description' => '默认资源发现不允许解除关联关系。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '解关联资源发现和IPAM实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DissociateIpamResourceDiscovery', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:DissociateIpamResourceDiscovery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamResourceDiscovery', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamresourcediscovery/{#IpamResourceDiscoveryId}', + ], + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'Ipam', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86137597-443F-5B66-B9B6-8514E0C50B8F\\"\\n}","type":"json"}]', + ], + 'GetIpamPoolAllocation' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池CIDR分配所属IPAM Pool的所在地域。'."\n" + ."\n" + .'> 当IPAM地址池CIDR分配所属IPAM Pool具备地域属性时，该属性为IPAM Pool的所在地域。当IPAM地址池CIDR分配所属IPAM Pool不具备地域属性时，该属性为IPAM托管地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolAllocationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池CIDR分配的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-alloc-112za33e4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamPoolAllocModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3748DEFF-68BE-5EED-9937-7C1D0C21BAB4', + ], + 'IpamPoolAllocationId' => [ + 'description' => 'IPAM地址池CIDR分配的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-alloc-112za33e4****', + ], + 'Cidr' => [ + 'description' => '分配的地址段。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + 'SourceCidr' => [ + 'description' => '源地址段。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'ResourceId' => [ + 'description' => '分配给的资源ID。', + 'type' => 'string', + 'example' => 'vpc-bp16qjewdsunr41m1****', + ], + 'ResourceType' => [ + 'description' => '分配给的资源类型。取值：'."\n" + ."\n" + .'- **VPC**：表示资源的类型为VPC。'."\n" + .'- **IpamPool**：表示资源的类型为子地址池。'."\n" + .'- **Custom**：表示资源的类型为自定义预留网段。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'ResourceRegionId' => [ + 'description' => '资源生效的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResourceOwnerId' => [ + 'description' => '资源归属的阿里云账号（主账号）ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1616080591216318', + ], + 'RegionId' => [ + 'description' => 'IPAM地址池CIDR分配所属IPAM Pool的所在地域。'."\n" + ."\n" + .'> 当IPAM地址池CIDR分配所属IPAM Pool具备地域属性时，该属性为IPAM Pool的所在地域。当IPAM地址池CIDR分配所属IPAM Pool不具备地域属性时，该属性为IPAM托管地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'IpamPoolId' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + 'Status' => [ + 'description' => '实例的状态。取值：'."\n" + ."\n" + .'- **Created**：表示创建完成。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + 'CreationTime' => [ + 'description' => '实例创建时间。', + 'type' => 'string', + 'example' => '2024-10-15T10:24:19+08:00', + ], + 'IpamPoolAllocationDescription' => [ + 'description' => 'IPAM地址池CIDR分配的描述信息。'."\n" + ."\n" + .'长度为1～256个字符，必须以大小写英文字母或中文字符开头，但不能以`http://`或`https://`开头。不填则为空，默认值为空。', + 'type' => 'string', + 'example' => 'ipam pool allocation description', + ], + 'IpamPoolAllocationName' => [ + 'description' => 'IPAM地址池CIDR分配的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'example' => 'ipam pool allocation name', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPoolAllocation', + 'errorMessage' => 'The specified resource of IPAM pool allocation is not found.', + 'description' => '输入的IPAM地址池分配关系不存在。', + ], + [ + 'errorCode' => 'OperationDenied.IpamRegionNotSupportGetPoolAllocation', + 'errorMessage' => 'The operation is not allowed because IPAM region does not support getting the allocation.', + 'description' => '无法在IPAM地域执行查询指定地址池分配的操作。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询指定IPAM地址池CIDR分配的信息', + 'summary' => '查询指定IPAM地址池CIDR分配的信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'GetIpamPoolAllocation', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vpc:GetIpamPoolAllocation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamPool', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3748DEFF-68BE-5EED-9937-7C1D0C21BAB4\\",\\n \\"IpamPoolAllocationId\\": \\"ipam-pool-alloc-112za33e4****\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"SourceCidr\\": \\"192.168.0.0/16\\",\\n \\"ResourceId\\": \\"vpc-bp16qjewdsunr41m1****\\",\\n \\"ResourceType\\": \\"VPC\\",\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceOwnerId\\": 1616080591216318,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\",\\n \\"Status\\": \\"Created\\",\\n \\"CreationTime\\": \\"2024-10-15T10:24:19+08:00\\",\\n \\"IpamPoolAllocationDescription\\": \\"ipam pool allocation description\\",\\n \\"IpamPoolAllocationName\\": \\"ipam pool allocation name\\"\\n}","type":"json"}]', + ], + 'GetIpamPoolNextAvailableCidr' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池所在地域。'."\n" + .'> 当IPAM地址池具备地域属性时，该参数为IPAM地址池生效地域；当IPAM地址池不具备地域属性时，该参数为IPAM托管地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'CidrBlock', + 'in' => 'query', + 'schema' => [ + 'description' => '需要分配的CIDR。'."\n" + ."\n" + .'> CidrBlock、CidrMask至少输入一个。', + 'type' => 'string', + 'required' => false, + 'example' => '172.68.0.0/26', + ], + ], + [ + 'name' => 'CidrMask', + 'in' => 'query', + 'schema' => [ + 'description' => '需要分配的CIDR掩码长度。'."\n" + .'> CidrBlock、CidrMask至少输入一个。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '26', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamPoolAllocModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '29FC6758-9B7C-5CC7-8CBF-4DD846FE7D82', + ], + 'CidrBlock' => [ + 'description' => '可用的CIDR。', + 'type' => 'string', + 'example' => '172.68.0.0/26', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParam.CidrOrCidrMask', + 'errorMessage' => 'The CIDR or CIDR Mask must be input.', + 'description' => '从IPAM地址池分配资源或查询可用资源时，请输入Cidr或CidrMask。', + ], + [ + 'errorCode' => 'ResourceNotEnough.IpamPoolCidr', + 'errorMessage' => 'The specified resource of IPAM pool CIDR is not enough.', + 'description' => '指定的IPAM地址池CIDR资源不足。', + ], + [ + 'errorCode' => 'OperationDenied.IpamRegionNotSupportGetPoolAvailableCidr', + 'errorMessage' => 'The operation is not allowed because IPAM region does not support getting available CIDR of IPAM pool.', + 'description' => '无法在IPAM地域执行获取地址池可用CIDR的操作。', + ], + [ + 'errorCode' => 'IllegalParam.Cidr', + 'errorMessage' => 'The specified CIDR is illegal.', + 'description' => '指定的CIDR不合法。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '获取IPAM地址池可用的CIDR地址段', + 'summary' => '获取IPAM地址池可用的CIDR地址段。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'GetIpamPoolNextAvailableCidr', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vpc:GetIpamPoolNextAvailableCidr', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamPool', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29FC6758-9B7C-5CC7-8CBF-4DD846FE7D82\\",\\n \\"CidrBlock\\": \\"172.68.0.0/26\\"\\n}","type":"json"}]', + ], + 'GetVpcIpamServiceStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + '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' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FEE9FFF-57EE-5832-BE88-9308352F3B68', + ], + 'Enabled' => [ + 'description' => '是否已开通IPAM服务。'."\n" + ."\n" + .'- **true**：已开通。'."\n" + .'- **false**：未开通。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询IPAM功能的开通状态', + 'summary' => '查询IPAM功能的开通状态。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'GetVpcIpamServiceStatus', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'vpc:GetVpcIpamServiceStatus', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FEE9FFF-57EE-5832-BE88-9308352F3B68\\",\\n \\"Enabled\\": true\\n}","type":"json"}]', + ], + 'ListIpamDiscoveredResource' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现实例的托管地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的操作地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- **VPC**：表示资源类型为VPC。'."\n" + ."\n" + .'- **VSwitch**：表示资源类型为交换机。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的**NextToken**值。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamDiscoveredResourceModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpamDiscoveredResources' => [ + 'description' => '资源列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '资源列表信息。', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '阿里云账号（主账号）ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132193271328****', + ], + 'ResourceType' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- **VPC**：表示资源类型为VPC。'."\n" + ."\n" + .'- **VSwitch**：表示资源类型为交换机。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'vpc-uf611fp465c7dyb4z****', + ], + 'ResourceOwnerId' => [ + 'description' => '资源归属的阿里云账号（主账号）ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132193271328****', + ], + 'ResourceRegionId' => [ + 'description' => '资源归属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Cidr' => [ + 'description' => '资源的地址段。', + 'type' => 'string', + 'example' => '192.168.1.0/32', + ], + 'IpUsage' => [ + 'description' => 'IP的利用率，小数形式。', + 'type' => 'string', + 'example' => '0', + ], + 'IpCountDetail' => [ + 'type' => 'object', + 'properties' => [ + 'FreeIpCount' => [ + 'type' => 'string', + 'description' => '', + ], + 'TotalIpCount' => [ + 'type' => 'string', + 'description' => '', + ], + 'UsedIpCount' => [ + 'type' => 'string', + 'description' => '', + ], + ], + 'description' => '', + ], + 'IpamResourceDiscoveryId' => [ + 'description' => '资源发现实例ID。', + 'type' => 'string', + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + 'VpcId' => [ + 'description' => '资源所属的VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-uf611fp465c7dyb4z****', + ], + 'DiscoveryTime' => [ + 'description' => '资源被发现的时间。'."\n" + ."\n" + .'> 如果资源被创建后未被修改过，资源被发现的时间保持不变。', + 'type' => 'string', + 'example' => '2024-01-01 00:00:00', + ], + 'SourceCidr' => [ + 'description' => '源CIDR地址段。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3748DEFF-68BE-5EED-9937-7C1D0C21BAB4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam.ResourceRegion', + 'errorMessage' => 'The input parameter ResourceRegionId is invalid.', + 'description' => '输入的参数ResourceRegionId未在操作地域中。', + ], + [ + 'errorCode' => 'ResourceNotFound.IpamResourceDiscovery', + 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', + 'description' => '未找到IPAM资源发现实例。', + ], + [ + 'errorCode' => 'MissingParam.IpamResourceDiscoveryId', + 'errorMessage' => 'The IpamResourceDiscoveryId must be input.', + 'description' => '查询发现的资源时，请输入参数IpamResourceDiscoveryId。', + ], + [ + 'errorCode' => 'MissingParam.ResourceRegionId', + 'errorMessage' => 'The ResourceRegionId must be input.', + 'description' => '查询发现的资源时，请输入参数ResourceRegionId。', + ], + ], + ], + 'title' => '查询资源发现下的资源信息', + 'summary' => '查询资源发现下的资源信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamDiscoveredResource', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListIpamDiscoveredResource', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamResourceDiscovery', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamresourcediscovery/{#IpamResourceDiscoveryId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamDiscoveredResources\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"ResourceType\\": \\"VPC\\",\\n \\"ResourceId\\": \\"vpc-uf611fp465c7dyb4z****\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"Cidr\\": \\"192.168.1.0/32\\",\\n \\"IpUsage\\": \\"0\\",\\n \\"IpCountDetail\\": {\\n \\"FreeIpCount\\": \\"\\",\\n \\"TotalIpCount\\": \\"\\",\\n \\"UsedIpCount\\": \\"\\"\\n },\\n \\"IpamResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"VpcId\\": \\"vpc-uf611fp465c7dyb4z****\\",\\n \\"DiscoveryTime\\": \\"2024-01-01 00:00:00\\",\\n \\"SourceCidr\\": \\"192.168.1.0/24\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"3748DEFF-68BE-5EED-9937-7C1D0C21BAB4\\"\\n}","type":"json"}]', + ], + 'ListIpamMembers' => [ + 'summary' => '查询IPAM可信服务纳管成员。', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~448570~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'MemberIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IPAM可信服务纳管成员ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM可信服务纳管成员ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'fd-ccccncASqa', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '20', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamScopeModel>', + 'description' => 'ListTokenResult<IpamScopeModel>', + 'type' => 'object', + 'properties' => [ + 'MemberInfos' => [ + 'description' => 'IPAM可信服务纳管成员信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '成员添加时间。', + 'type' => 'string', + 'example' => '2025-07-11T07:18:07Z', + ], + 'MemberId' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'- **Folder ID**：资源夹ID。'."\n" + ."\n" + .'- **Account UID**：资源目录成员账号UID。', + 'type' => 'string', + 'example' => 'fd-ccccncASqa', + ], + 'MemberType' => [ + 'description' => '成员类型，取值：'."\n" + ."\n" + .'- **Folder**：资源夹。'."\n" + ."\n" + .'- **Account**：资源目录成员账号。', + 'type' => 'string', + 'example' => 'Folder', + ], + 'Status' => [ + 'description' => 'IPAM可信服务纳管成员的成员状态。取值：'."\n" + ."\n" + .'- **Created**：表示成员已纳管完成。'."\n" + .'- **Deleted**：表示成员已移除。', + 'type' => 'string', + 'example' => 'Created', + ], + ], + 'description' => '', + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '查询的条目总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B90776C8-F703-51D5-893A-AD1CA699D535', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.IpamNotExist', + 'errorMessage' => 'The operation is not allowed because the IPAM does not exist.', + 'description' => '当前地域IPAM不存在，不允许纳管IPAM可信服务成员。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询IPAM可信服务纳管成员', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListIpamMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MemberInfos\\": [\\n {\\n \\"CreationTime\\": \\"2025-07-11T07:18:07Z\\",\\n \\"MemberId\\": \\"fd-ccccncASqa\\",\\n \\"MemberType\\": \\"Folder\\",\\n \\"Status\\": \\"Created\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 6,\\n \\"RequestId\\": \\"B90776C8-F703-51D5-893A-AD1CA699D535\\"\\n}","type":"json"}]', + ], + 'ListIpamPoolAllocations' => [ + 'summary' => '查询IPAM地址池的CIDR分配信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池CIDR分配所属IPAM Pool的所在地域。'."\n" + ."\n" + .'> 当IPAM地址池CIDR分配所属IPAM Pool具备地域属性时，该属性为IPAM Pool的所在地域。当IPAM地址池CIDR分配所属IPAM Pool不具备地域属性时，该属性为IPAM托管地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'IpamPoolAllocationIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IPAM地址池CIDR分配的实例ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM地址池CIDR分配的实例ID。最多支持输入20个实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-pool-alloc-112za33e4****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Cidr', + 'in' => 'query', + 'schema' => [ + 'description' => '通过指定分配的地址段查询分配信息。'."\n" + ."\n" + .'> 目前，只支持IPv4类型的地址段。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.0/24', + ], + ], + [ + 'name' => 'IpamPoolAllocationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池CIDR分配的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test name', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamPoolAllocationModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpamPoolAllocations' => [ + 'description' => 'IPAM地址池CIDR分配列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM地址池CIDR分配列表。', + 'type' => 'object', + 'properties' => [ + 'IpamPoolAllocationId' => [ + 'description' => 'IPAM地址池CIDR分配的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-alloc-112za33e4****', + ], + 'Cidr' => [ + 'description' => '分配的地址段。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + 'SourceCidr' => [ + 'description' => '源地址段。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'ResourceId' => [ + 'description' => '分配给的资源ID。', + 'type' => 'string', + 'example' => 'vpc-bp16qjewdsunr41m1****', + ], + 'ResourceType' => [ + 'description' => '分配给的资源类型。取值：'."\n" + ."\n" + .'- **VPC**：表示资源的类型为VPC。'."\n" + .'- **IpamPool**：表示资源的类型为子地址池。'."\n" + .'- **Custom**：表示资源的类型为自定义预留网段。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'Custom', + ], + 'ResourceRegionId' => [ + 'description' => '资源生效的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ResourceOwnerId' => [ + 'description' => '资源归属的阿里云账号（主账号）ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132193271328****', + ], + 'RegionId' => [ + 'description' => 'IPAM地址池CIDR分配所属IPAM Pool的所在地域。'."\n" + ."\n" + .'> 当IPAM地址池CIDR分配所属IPAM Pool具备地域属性时，该属性为IPAM Pool的所在地域。当IPAM地址池CIDR分配所属IPAM Pool不具备地域属性时，该属性为IPAM托管地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'IpamPoolId' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + 'Status' => [ + 'description' => '实例的状态。取值：'."\n" + ."\n" + .'- **Created**：表示创建完成。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + 'CreationTime' => [ + 'description' => '实例创建时间。', + 'type' => 'string', + 'example' => '2023-05-19T08:59:18Z', + ], + 'IpamPoolAllocationDescription' => [ + 'description' => 'IPAM地址池CIDR分配的描述信息。', + 'type' => 'string', + 'example' => 'test description', + ], + 'IpamPoolAllocationName' => [ + 'description' => 'IPAM地址池CIDR分配的名称。', + 'type' => 'string', + 'example' => 'test name', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3748DEFF-68BE-5EED-9937-7C1D0C21BAB4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.IpamRegionNotSupportListPoolAllocation', + 'errorMessage' => 'The operation is not allowed because IPAM region does not support listing allocations.', + 'description' => '无法在IPAM地域执行查询地址池分配的操作。', + ], + ], + ], + 'title' => '查询IPAM地址池的CIDR分配信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamPoolAllocations', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListIpamPoolAllocations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamPoolAllocations\\": [\\n {\\n \\"IpamPoolAllocationId\\": \\"ipam-pool-alloc-112za33e4****\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"SourceCidr\\": \\"192.168.0.0/16\\",\\n \\"ResourceId\\": \\"vpc-bp16qjewdsunr41m1****\\",\\n \\"ResourceType\\": \\"Custom\\",\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\",\\n \\"Status\\": \\"Created\\",\\n \\"CreationTime\\": \\"2023-05-19T08:59:18Z\\",\\n \\"IpamPoolAllocationDescription\\": \\"test description\\",\\n \\"IpamPoolAllocationName\\": \\"test name\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"3748DEFF-68BE-5EED-9937-7C1D0C21BAB4\\"\\n}","type":"json"}]', + ], + 'ListIpamPoolCidrs' => [ + 'summary' => '查询IPAM地址池预置的CIDR地址段。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'Cidr', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的预置CIDR地址段。'."\n" + ."\n" + .'> 目前，只支持IPv4类型的地址段。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.0/24', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamPoolCidrModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpamPoolCidrs' => [ + 'description' => 'IPAM地址池预置的CIDR地址段列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM地址池预置的CIDR地址段列表。', + 'type' => 'object', + 'properties' => [ + 'IpamPoolId' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + 'Cidr' => [ + 'description' => '预置的CIDR地址段。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + 'Status' => [ + 'description' => 'IPAM地址池预置CIDR的实例状态。取值：'."\n" + ."\n" + .'- **Created**：表示创建完成。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '查询的条目总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9E7CCB95-62E0-534D-9B9A-71F27E8B71B1', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.PoolRegionNotSupportListPoolCidr', + 'errorMessage' => 'The operation is not allowed because pool region does not support listing cidrs.', + 'description' => '操作被拒绝，原因是无法在该地域执行查询地址池CIDR操作。', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamPoolCidrs\\": [\\n {\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"Status\\": \\"Created\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"9E7CCB95-62E0-534D-9B9A-71F27E8B71B1\\"\\n}","type":"json"}]', + 'title' => '查询IPAM地址池预置的CIDR地址段', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamPoolCidrs', + ], + ], + ], + 'ramActions' => [], + ], + 'ListIpamPools' => [ + 'summary' => '查询IPAM地址池信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamScopeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + ], + [ + 'name' => 'IpamPoolIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID列表。N的取值范围为1~100，即一次最多查询100个IPAM地址池。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'IpamPoolName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SourceIpamPoolId', + 'in' => 'query', + 'schema' => [ + 'title' => '不传值：正常分页获取pool', + 'description' => '源IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-pool-lfnwi4jok1ss0g****', + ], + ], + [ + 'name' => 'PoolRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池生效地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池所属的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2sermdd6****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'一个标签值最多支持128个字符，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + '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，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'IsShared', + 'in' => 'query', + 'schema' => [ + 'description' => '是否是共享的地址池。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'IpVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP地址协议版本。取值：'."\n" + ."\n" + .'- **IPv4**：IPv4协议。'."\n" + ."\n" + .'- **IPv6**：IPv6协议。', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + [ + 'name' => 'Ipv6Isp', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPv6地址段类型，仅对公网IPv6地址池生效。取值：'."\n" + ."\n" + .'- **BGP**（默认值）：阿里云BGP IPv6。'."\n" + .'- **ChinaMobile**：中国移动（单线）。'."\n" + .'- **ChinaUnicom**：中国联通（单线）。'."\n" + .'- **ChinaTelecom**：中国电信（单线）。'."\n" + ."\n" + .'> 如果是开通了单线带宽白名单的用户，该字段可以设置为**ChinaTelecom**（中国电信）、**ChinaUnicom**（中国联通）或**ChinaMobile**（中国移动）。', + 'type' => 'string', + 'required' => false, + 'example' => 'BGP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamPoolModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpamPools' => [ + 'description' => 'IPAM地址池列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM地址池列表。', + 'type' => 'object', + 'properties' => [ + 'IpamId' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'example' => 'ipam-b5mtlx3q7xcnyr****', + ], + 'IpamScopeId' => [ + 'description' => 'IPAM作用范围的实例ID。', + 'type' => 'string', + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + 'IpamScopeType' => [ + 'description' => 'IPAM作用范围的作用域类型。取值：'."\n" + ."\n" + .'- **public**：表示为公网类型。'."\n" + .'- **private**：表示为私网类型。', + 'type' => 'string', + 'example' => 'private', + ], + 'IpamPoolId' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + 'IpamPoolName' => [ + 'description' => 'IPAM地址池的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'IpamPoolDescription' => [ + 'description' => 'IPAM地址池的描述。', + 'type' => 'string', + 'example' => 'test description', + ], + 'CreateTime' => [ + 'description' => 'IPAM地址池的创建时间。', + 'type' => 'string', + 'example' => '2023-04-19T16:49:01Z', + ], + 'RegionId' => [ + 'description' => '查询请求对应的当前地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'PoolDepth' => [ + 'description' => 'IPAM地址池的深度。取值范围：**0~10**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HasSubPool' => [ + 'description' => '是否有子地址池。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'SourceIpamPoolId' => [ + 'description' => '源IPAM地址池的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-lfnwi4jok1ss0g****', + ], + 'Status' => [ + 'description' => 'IPAM地址池实例的状态。取值：'."\n" + ."\n" + .'- **Creating**：表示创建中。'."\n" + .'- **Created**：表示创建完成。'."\n" + .'- **Modifying**：表示修改中。'."\n" + .'- **Deleting**：表示删除中。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + 'IpVersion' => [ + 'description' => 'IP地址协议版本。', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'AllocationDefaultCidrMask' => [ + 'description' => 'IPAM地址池分配的默认网络掩码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '28', + ], + 'AllocationMaxCidrMask' => [ + 'description' => 'IPAM地址池分配的最大网络掩码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + ], + 'AllocationMinCidrMask' => [ + 'description' => 'IPAM地址池分配的最小网络掩码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'ResourceGroupId' => [ + 'description' => 'IPAM地址池的资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxazb4ph6aiy****', + ], + 'Tags' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + ], + ], + ], + 'PoolRegionId' => [ + 'description' => '查询到的IPAM地址池的生效地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'IpamRegionId' => [ + 'description' => '查询到的IPAM地址池所属IPAM实例的托管地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OwnerId' => [ + 'description' => 'IPAM地址池资源拥有者的阿里云主账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1210123456******', + ], + 'AutoImport' => [ + 'description' => '地址池是否开启自动导入功能。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsShared' => [ + 'description' => '是否是共享的地址池。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Ipv6Isp' => [ + 'description' => 'IPv6地址段类型。', + 'type' => 'string', + 'example' => 'BGP', + ], + 'Cidrs' => [ + 'description' => '地址池预置的CIDR地址段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '地址池预置的CIDR地址段。', + 'type' => 'string', + 'example' => '10.214.0.0/16', + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '查询的条目总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B54867DE-83DC-56B4-A57E-69A03119D0B1', + ], + ], + ], + ], + ], + 'title' => '查询IPAM地址池信息', + 'changeSet' => [ + [ + 'createdAt' => '2025-05-16T06:50:59.000Z', + 'description' => 'OpenAPI 下线', + ], + [ + 'createdAt' => '2025-04-29T06:52:08.000Z', + 'description' => 'OpenAPI 下线', + ], + [ + 'createdAt' => '2025-04-29T06:51:34.000Z', + 'description' => 'OpenAPI 下线', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamPools', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListIpamPools', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamPool', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamPools\\": [\\n {\\n \\"IpamId\\": \\"ipam-b5mtlx3q7xcnyr****\\",\\n \\"IpamScopeId\\": \\"ipam-scope-glfmcyldpm8lsy****\\",\\n \\"IpamScopeType\\": \\"private\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\",\\n \\"IpamPoolName\\": \\"test\\",\\n \\"IpamPoolDescription\\": \\"test description\\",\\n \\"CreateTime\\": \\"2023-04-19T16:49:01Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"PoolDepth\\": 2,\\n \\"HasSubPool\\": true,\\n \\"SourceIpamPoolId\\": \\"ipam-pool-lfnwi4jok1ss0g****\\",\\n \\"Status\\": \\"Created\\",\\n \\"IpVersion\\": \\"IPv4\\",\\n \\"AllocationDefaultCidrMask\\": 28,\\n \\"AllocationMaxCidrMask\\": 32,\\n \\"AllocationMinCidrMask\\": 8,\\n \\"ResourceGroupId\\": \\"rg-acfmxazb4ph6aiy****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceJoshua\\"\\n }\\n ],\\n \\"PoolRegionId\\": \\"cn-hangzhou\\",\\n \\"IpamRegionId\\": \\"cn-hangzhou\\",\\n \\"OwnerId\\": 0,\\n \\"AutoImport\\": true,\\n \\"IsShared\\": true,\\n \\"Ipv6Isp\\": \\"BGP\\",\\n \\"Cidrs\\": [\\n \\"10.214.0.0/16\\"\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"B54867DE-83DC-56B4-A57E-69A03119D0B1\\"\\n}","type":"json"}]', + ], + 'ListIpamResourceCidrs' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。'."\n" + ."\n" + .'您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamScopeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + ], + [ + 'name' => 'IpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID。'."\n" + ."\n" + .'> **IpamPoolId**不能是共享地址池的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp16qjewdsunr41m1****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- **VPC**：表示资源类型为VPC。'."\n" + .'- **VSwitch**：表示资源类型为交换机。', + 'type' => 'string', + 'required' => false, + 'example' => 'VPC', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所属的VPC实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1fjfnrg3av6zb9e****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamResourceCidrModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpamResourceCidrs' => [ + 'description' => '资源信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源信息列表。', + 'type' => 'object', + 'properties' => [ + 'AliUid' => [ + 'description' => '阿里云账号（主账号）ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132193271328****', + ], + 'ResourceType' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- **VPC**：表示资源类型为VPC。'."\n" + .'- **VSwitch**：表示资源类型为交换机。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'vpc-bp16qjewdsunr41m1****', + ], + 'ResourceOwnerId' => [ + 'description' => '资源归属的阿里云账号（主账号）ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132193271328****', + ], + 'ResourceRegionId' => [ + 'description' => '资源的生效地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Cidr' => [ + 'description' => '资源的地址段。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + 'SourceCidr' => [ + 'description' => '源CIDR地址段。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + 'Status' => [ + 'description' => 'IPAM地址池中的资源状态。取值：'."\n" + ."\n" + .'- **Created**：表示已创建。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + 'ManagementStatus' => [ + 'description' => '资源的管理状态。'."\n" + ."\n" + .'- **Managed（托管）**：该资源具有从IPAM地址池中分配的CIDR，IPAM 正在监控该资源是否可能与CIDR重叠以及是否符合池分配规则。'."\n" + .'- **Unmanaged（非托管）**：该资源不具有从 IPAM 池中分配的CIDR，IPAM正在监控该资源是否可能存在符合池分配规则的CIDR，并监控CIDR是否存在重叠。'."\n" + .'- **Ignored（已忽略）**：已选择该资源免于监控。不会评估忽略的资源是否存在重叠或分配规则合规性。选择忽略资源时，从IPAM地址池中分配给它的任何空间都将返回到池中，并且不会通过自动导入再次导入该资源（如果在地址池中设置了自动导入分配规则）。', + 'type' => 'string', + 'example' => 'Managed', + ], + 'ComplianceStatus' => [ + 'description' => '资源的合规状态。'."\n" + ."\n" + .'- **Compliant（合规）**：托管式资源的CIDR符合IPAM地址池的分配规则。'."\n" + .'- **Noncompliant（不合规）**：托管式资源的CIDR不符合IPAM地址池的一条或多条分配规则。'."\n" + .'- **Ignored（已忽略）**：已选择该资源免于监控。不会评估忽略的资源是否存在重叠或分配规则合规性。'."\n" + .'- **Unmanaged（非托管式）**：资源不具备从IPAM地址池中分配的CIDR，IPAM不监控该资源的CIDR是否符合地址池的分配规则，将监控CIDR是否存在重叠。', + 'type' => 'string', + 'example' => 'Compliant', + ], + 'OverlapStatus' => [ + 'description' => '资源的重叠状态。'."\n" + ."\n" + .'- **Nonoverlapping（不重叠）**：资源的CIDR不与相同作用范围内的其他CIDR重叠。'."\n" + .'- **Overlapping（重叠）**：资源的CIDR与相同作用范围内的另一个CIDR重叠。'."\n" + .'- **Ignored（已忽略）**：已选择该资源免于监控。不会评估忽略的资源是否存在重叠或分配规则合规性。', + 'type' => 'string', + 'example' => 'Nonoverlapping', + ], + 'IpUsage' => [ + 'description' => 'IP的利用率，小数形式。', + 'type' => 'string', + 'example' => '0', + ], + 'IpCountDetail' => [ + 'description' => '资源IP地址数量详情。', + 'type' => 'object', + 'properties' => [ + 'FreeIpCount' => [ + 'description' => '可分配IP地址数量。', + 'type' => 'string', + 'example' => '252', + ], + 'TotalIpCount' => [ + 'description' => '总IP地址数量。', + 'type' => 'string', + 'example' => '256', + ], + 'UsedIpCount' => [ + 'description' => '已分配IP地址数量。', + 'type' => 'string', + 'example' => '4', + ], + ], + ], + 'IpamId' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'example' => 'ipam-uq5dcfc2eqhpf4****', + ], + 'IpamScopeId' => [ + 'description' => 'IPAM作用范围的实例ID。', + 'type' => 'string', + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + 'IpamPoolId' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-6rcq3tobayc20t***', + ], + 'IpamAllocationId' => [ + 'description' => 'IPAM地址池CIDR分配的实例ID。', + 'type' => 'string', + 'example' => 'ipam-pool-alloc-112za33e4****', + ], + 'VpcId' => [ + 'description' => '资源所属的VPC实例ID。', + 'type' => 'string', + 'example' => 'vpc-bp1fjfnrg3av6zb9e****', + ], + 'OverlapDetail' => [ + 'description' => '与当前资源重叠的资源信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OverlapResourceId' => [ + 'description' => '与当前资源重叠的实例ID。', + 'type' => 'string', + 'example' => 'vpc-aq3fjgnig5av6jb8d****', + ], + 'OverlapResourceRegion' => [ + 'description' => '与当前资源重叠的实例地域信息。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OverlapResourceCidr' => [ + 'description' => '与当前资源重叠的CIDR信息。', + 'type' => 'string', + 'example' => '192.168.1.0/24', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '49A9DE56-B68C-5FFC-BC06-509D086F287C', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Forbidden.QueryShareResource', + 'errorMessage' => 'Authentication is failed for querying a shared IPAM pool.', + 'description' => '查询共享IPAM地址池的资源失败。', + ], + ], + ], + 'title' => '查询IPAM作用范围内的资源', + 'summary' => '查询IPAM作用范围内的资源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamResourceCidrs', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListIpamResourceCidrs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamScope', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamResourceCidrs\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"ResourceType\\": \\"VPC\\",\\n \\"ResourceId\\": \\"vpc-bp16qjewdsunr41m1****\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"SourceCidr\\": \\"192.168.1.0/24\\",\\n \\"Status\\": \\"Created\\",\\n \\"ManagementStatus\\": \\"Managed\\",\\n \\"ComplianceStatus\\": \\"Compliant\\",\\n \\"OverlapStatus\\": \\"Nonoverlapping\\",\\n \\"IpUsage\\": \\"0\\",\\n \\"IpCountDetail\\": {\\n \\"FreeIpCount\\": \\"252\\",\\n \\"TotalIpCount\\": \\"256\\",\\n \\"UsedIpCount\\": \\"4\\"\\n },\\n \\"IpamId\\": \\"ipam-uq5dcfc2eqhpf4****\\",\\n \\"IpamScopeId\\": \\"ipam-scope-glfmcyldpm8lsy****\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t***\\",\\n \\"IpamAllocationId\\": \\"ipam-pool-alloc-112za33e4****\\",\\n \\"VpcId\\": \\"vpc-bp1fjfnrg3av6zb9e****\\",\\n \\"OverlapDetail\\": [\\n {\\n \\"OverlapResourceId\\": \\"vpc-aq3fjgnig5av6jb8d****\\",\\n \\"OverlapResourceRegion\\": \\"cn-hangzhou\\",\\n \\"OverlapResourceCidr\\": \\"192.168.1.0/24\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"49A9DE56-B68C-5FFC-BC06-509D086F287C\\"\\n}","type":"json"}]', + ], + 'ListIpamResourceDiscoveries' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询资源发现的地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2sermdd6****', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源发现的实例ID列表。N的取值范围为1~100，即一次最多查询100个资源发现实例。', + 'type' => 'array', + 'items' => [ + 'description' => '资源发现的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'IpamResourceDiscoveryName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以http://或https://开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的类型。'."\n" + ."\n" + .'> 当前支持的类型：'."\n" + .'>- system：系统创建的默认资源发现。'."\n" + .'>- custom：用户创建的自定义类型的资源发现。', + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'一个标签值最多支持128个字符，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'IsShared', + 'in' => 'query', + 'schema' => [ + 'description' => '是否是共享的资源发现。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamResourceDiscoveryModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpamResourceDiscoveries' => [ + 'description' => '资源发现的实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源发现的实例列表。', + 'type' => 'object', + 'properties' => [ + 'IpamResourceDiscoveryId' => [ + 'description' => '资源发现的实例ID。', + 'type' => 'string', + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + 'IpamResourceDiscoveryName' => [ + 'description' => '资源发现的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'IpamResourceDiscoveryDescription' => [ + 'description' => '资源发现的描述信息。', + 'type' => 'string', + 'example' => 'test description', + ], + 'OperatingRegionList' => [ + 'description' => '资源发现的操作地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源发现的操作地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'Type' => [ + 'description' => '资源发现的类型。', + 'type' => 'string', + 'example' => 'system', + ], + 'IpamResourceDiscoveryStatus' => [ + 'description' => '资源发现实例的状态。取值：'."\n" + .'- **Creating**：表示创建中。'."\n" + .'- **Created**：表示创建完成。'."\n" + .'- **Modifying**：表示修改中。'."\n" + .'- **Deleting**：表示删除中。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + 'ResourceGroupId' => [ + 'description' => '资源发现的资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek2sermdd6****', + ], + 'CreateTime' => [ + 'description' => '资源发现创建的时间。', + 'type' => 'string', + 'example' => '2022-07-01T02:05:23Z', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + ], + ], + ], + 'RegionId' => [ + 'description' => '查询到的资源发现实例的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OwnerId' => [ + 'description' => '资源发现实例资源拥有者的阿里云主账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1210123456******', + ], + 'ShareType' => [ + 'description' => '资源的共享状态。'."\n" + ."\n" + .'- 取值为空时，表示该资源发现为普通的实例。'."\n" + ."\n" + .'- 取值为Shared时，表示该资源发现来自共享。'."\n" + ."\n" + .'- 取值为Sharing时，表示该资源发现在共享中。', + 'type' => 'string', + 'example' => 'Shared', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '86137597-443F-5B66-B9B6-8514E0C50B8F', + ], + ], + ], + ], + ], + 'title' => '查询资源发现实例', + 'summary' => '查询IPAM资源发现实例。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamResourceDiscoveries', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListIpamResourceDiscoveries', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamResourceDiscoveries\\": [\\n {\\n \\"IpamResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"IpamResourceDiscoveryName\\": \\"test\\",\\n \\"IpamResourceDiscoveryDescription\\": \\"test description\\",\\n \\"OperatingRegionList\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"Type\\": \\"system\\",\\n \\"IpamResourceDiscoveryStatus\\": \\"Created\\",\\n \\"ResourceGroupId\\": \\"rg-aek2sermdd6****\\",\\n \\"CreateTime\\": \\"2022-07-01T02:05:23Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceJoshua\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"OwnerId\\": 0,\\n \\"ShareType\\": \\"Shared\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 1,\\n \\"RequestId\\": \\"86137597-443F-5B66-B9B6-8514E0C50B8F\\"\\n}","type":"json"}]', + ], + 'ListIpamResourceDiscoveryAssociations' => [ + 'summary' => '查询资源发现和IPAM的关联关系。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamResourceDiscoveryModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpamResourceDiscoveryAssociations' => [ + 'description' => '关联关系信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '关联关系信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpamResourceDiscoveryId' => [ + 'description' => '资源发现的实例ID。', + 'type' => 'string', + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + 'IpamId' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + 'Status' => [ + 'description' => '关联关系状态。取值：'."\n" + ."\n" + .'- **Created**：表示已创建。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + 'IpamResourceDiscoveryOwnerId' => [ + 'description' => '资源发现实例归属的阿里云账号（主账号）ID。', + 'type' => 'string', + 'example' => '1210123456******', + ], + 'IpamResourceDiscoveryType' => [ + 'description' => '资源发现的类型。取值：'."\n" + .'- **system**：表示系统创建的默认资源发现。'."\n" + .'- **custom**：表示用户创建的自定义类型的资源发现。', + 'type' => 'string', + 'example' => 'custom', + ], + 'IpamResourceDiscoveryStatus' => [ + 'description' => '资源发现实例的状态。取值：'."\n" + .'- **Creating**：表示创建中。'."\n" + .'- **Created**：表示创建完成。'."\n" + .'- **Modifying**：表示修改中。'."\n" + .'- **Deleting**：表示删除中。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '本次请求条件下的数据总量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F28A239E-F88D-500E-ADE7-FA5E8CA3A170', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询资源发现和IPAM的关联关系', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamResourceDiscoveryAssociations', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListIpamResourceDiscoveryAssociations', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamResourceDiscoveryAssociations\\": [\\n {\\n \\"IpamResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"IpamId\\": \\"ipam-ccxbnsbhew0d6t****\\",\\n \\"Status\\": \\"Created\\",\\n \\"IpamResourceDiscoveryOwnerId\\": \\"1210123456******\\",\\n \\"IpamResourceDiscoveryType\\": \\"custom\\",\\n \\"IpamResourceDiscoveryStatus\\": \\"Created\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"F28A239E-F88D-500E-ADE7-FA5E8CA3A170\\"\\n}","type":"json"}]', + ], + 'ListIpamScopes' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + ], + [ + 'name' => 'IpamScopeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围的作用域类型。取值：'."\n" + ."\n" + .'- **public**：表示为公网类型。'."\n" + .'- **private**：表示为私网类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'private', + ], + ], + [ + 'name' => 'IpamScopeIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IPAM作用范围的实例ID列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM作用范围的实例ID。最多支持输入20个实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'IpamScopeName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围所属的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2sermdd6****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '资源的标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + '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，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamScopeModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'IpamScopes' => [ + 'description' => 'IPAM作用范围列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM作用范围列表。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => 'IPAM作用范围的创建时间。', + 'type' => 'string', + 'example' => '2022-04-18T03:12:37Z', + ], + 'IpamScopeId' => [ + 'description' => 'IPAM作用范围的实例ID。', + 'type' => 'string', + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + 'IpamScopeType' => [ + 'description' => 'IPAM作用范围的作用域类型。取值：'."\n" + ."\n" + .'- **public**：表示为公网类型。'."\n" + .'- **private**：表示为私网类型。', + 'type' => 'string', + 'example' => 'private', + ], + 'Status' => [ + 'description' => 'IPAM作用范围的状态。取值：'."\n" + ."\n" + .'- **Creating**：表示创建中。'."\n" + .'- **Created**：表示创建完成。'."\n" + .'- **Deleting**：表示删除中。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + 'IpamId' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + 'PoolCount' => [ + 'description' => 'IPAM作用范围作用域下包含的地址池的个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'IpamScopeName' => [ + 'description' => 'IPAM作用范围的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'IpamScopeDescription' => [ + 'description' => 'IPAM作用范围的描述信息。', + 'type' => 'string', + 'example' => 'test description', + ], + 'ResourceGroupId' => [ + 'description' => 'IPAM作用范围的资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxazb4ph6aiy****', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'FinanceDept', + ], + ], + ], + ], + 'IsDefault' => [ + 'description' => '是否为默认作用域，取值：'."\n" + .' '."\n" + .'- **true**：是默认作用域。'."\n" + .'- **false**：不是默认作用域。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RegionId' => [ + 'description' => '查询到的IPAM作用范围的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OwnerId' => [ + 'description' => 'IPAM作用范围资源拥有者的阿里云主账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1210123456******', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '查询的条目总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8859C501-97E7-53D4-B94B-2A9E16003B22', + ], + ], + ], + ], + ], + 'title' => '查询IPAM作用范围的实例信息', + 'summary' => '查询IPAM作用范围的实例信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamScopes', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListIpamScopes', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamScope', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamScopes\\": [\\n {\\n \\"CreateTime\\": \\"2022-04-18T03:12:37Z\\",\\n \\"IpamScopeId\\": \\"ipam-scope-glfmcyldpm8lsy****\\",\\n \\"IpamScopeType\\": \\"private\\",\\n \\"Status\\": \\"Created\\",\\n \\"IpamId\\": \\"ipam-ccxbnsbhew0d6t****\\",\\n \\"PoolCount\\": 2,\\n \\"IpamScopeName\\": \\"test\\",\\n \\"IpamScopeDescription\\": \\"test description\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxazb4ph6aiy****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceDept\\"\\n }\\n ],\\n \\"IsDefault\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"OwnerId\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"8859C501-97E7-53D4-B94B-2A9E16003B22\\"\\n}","type":"json"}]', + ], + 'ListIpams' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~448570~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2sermdd6****', + ], + ], + [ + 'name' => 'IpamIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IPAM的实例ID列表。N的取值范围为1~100，即一次最多查询100个IPAM实例。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'IpamName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'一个标签值最多支持128个字符，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + '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，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<IpamModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'Ipams' => [ + 'description' => 'IPAM实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM实例列表。', + 'type' => 'object', + 'properties' => [ + 'IpamId' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + 'IpamName' => [ + 'description' => 'IPAM的名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'IpamDescription' => [ + 'description' => 'IPAM的描述信息。', + 'type' => 'string', + 'example' => 'test description', + ], + 'OperatingRegionList' => [ + 'description' => 'IPAM的生效地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IPAM生效地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + 'PrivateDefaultScopeId' => [ + 'description' => '创建IPAM后，系统默认创建的私网IPAM作用范围。', + 'type' => 'string', + 'example' => 'ipam-scope-okoerbco6unqfr****', + ], + 'PublicDefaultScopeId' => [ + 'description' => '创建IPAM后，系统默认创建的公网IPAM作用范围。', + 'type' => 'string', + 'example' => 'ipam-scope-ovb76p1g1m19dr****', + ], + 'ScopeCount' => [ + 'description' => 'IPAM作用范围的个数。取值范围：**2~5**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'IpamStatus' => [ + 'description' => 'IPAM实例的状态。取值：'."\n" + ."\n" + .'- **Creating**：表示创建中。'."\n" + .'- **Created**：表示创建完成。'."\n" + .'- **Deleting**：表示删除中。'."\n" + .'- **Deleted**：表示已删除。', + 'type' => 'string', + 'example' => 'Created', + ], + 'ResourceGroupId' => [ + 'description' => 'IPAM的资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek2dbprgpt****', + ], + 'CreateTime' => [ + 'description' => 'IPAM创建的时间。', + 'type' => 'string', + 'example' => '2022-07-01T02:05:23Z', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + ], + ], + ], + 'RegionId' => [ + 'description' => '查询到的IPAM实例的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'OwnerId' => [ + 'description' => 'IPAM实例资源拥有者的阿里云主账号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1210123456******', + ], + 'DefaultResourceDiscoveryId' => [ + 'description' => '默认资源发现实例ID。', + 'type' => 'string', + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + 'DefaultResourceDiscoveryAssociationId' => [ + 'description' => '默认的资源发现关联关系ID。', + 'type' => 'string', + 'example' => 'ipam-res-disco-assoc-jt5fac8twugdbbgip****', + ], + 'ResourceDiscoveryAssociationCount' => [ + 'description' => '资源发现数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'TotalCount' => [ + 'description' => '列表条目数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'MaxResults' => [ + 'description' => '分批次查询时返回的最多条目数。取值范围：1~100，默认值为10。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Count' => [ + 'description' => '分批次查询时返回的具体条目数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '23CA0A0B-B0F5-5495-B355-7D9A9203A46B', + ], + ], + ], + ], + ], + 'title' => '查询IPAM实例', + 'summary' => '查询ipam。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpams', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListIpams', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ipams\\": [\\n {\\n \\"IpamId\\": \\"ipam-ccxbnsbhew0d6t****\\",\\n \\"IpamName\\": \\"test\\",\\n \\"IpamDescription\\": \\"test description\\",\\n \\"OperatingRegionList\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"PrivateDefaultScopeId\\": \\"ipam-scope-okoerbco6unqfr****\\",\\n \\"PublicDefaultScopeId\\": \\"ipam-scope-ovb76p1g1m19dr****\\",\\n \\"ScopeCount\\": 2,\\n \\"IpamStatus\\": \\"Created\\",\\n \\"ResourceGroupId\\": \\"rg-aek2dbprgpt****\\",\\n \\"CreateTime\\": \\"2022-07-01T02:05:23Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceJoshua\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"OwnerId\\": 0,\\n \\"DefaultResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"DefaultResourceDiscoveryAssociationId\\": \\"ipam-res-disco-assoc-jt5fac8twugdbbgip****\\",\\n \\"ResourceDiscoveryAssociationCount\\": 1\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 10,\\n \\"MaxResults\\": 20,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"23CA0A0B-B0F5-5495-B355-7D9A9203A46B\\"\\n}","type":"json"}]', + ], + 'ListTagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。最多支持输入50个资源ID。'."\n" + ."\n" + .'> 参数**ResourceId.N**或**Tag.N**（**Tag.N.Key**与**Tag.N.Value**）至少输入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + 'required' => false, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- **IPAM**：表示资源类型为IPAM。'."\n" + .'- **IPAMSCOPE**：表示资源类型为IPAM作用范围。'."\n" + .'- **IPAMPOOL**：表示资源类型为IPAM地址池。', + 'type' => 'string', + 'required' => true, + 'example' => 'IPAM', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。最多支持20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'> 参数**ResourceId.N**或**Tag.N**（**Tag.N.Key**与**Tag.N.Value**）至少输入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '资源的标签值。最多支持20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能包含`http://`或者`https://`。'."\n" + ."\n" + .'> 参数**ResourceId.N**或**Tag.N**（**Tag.N.Key**与**Tag.N.Value**）至少输入一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + ."\n" + .'- 第一次查询和没有下一次查询时，均无需填写。'."\n" + .'- 如果有下一次查询，取值为上一次API调用返回的NextToken值。', + 'type' => 'string', + 'required' => false, + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '分批次查询时每次显示的条目数。取值范围：1~50，默认值为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'ListTokenResult<TagResourceModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'TagResources' => [ + 'description' => '绑定标签的资源信息。', + 'type' => 'array', + 'items' => [ + 'description' => '绑定标签的资源信息。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'FinanceDept', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'FinanceJoshua', + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'ipam-uq5dcfc2eqhpf4****', + ], + 'ResourceType' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- **IPAM**：表示资源类型为IPAM。'."\n" + .'- **IPAMSCOPE**：表示资源类型为IPAM作用范围。'."\n" + .'- **IPAMPOOL**：表示资源类型为IPAM地址池。', + 'type' => 'string', + 'example' => 'IPAM', + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '是否拥有下一次查询的令牌（Token）。取值：'."\n" + .'- 如果**NextToken**为空表示没有下一次查询。'."\n" + .'- 如果**NextToken**有返回值，该取值表示下一次查询开始的令牌。', + 'type' => 'string', + 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '672053AB-90C9-5693-AB96-458F137A5ED6', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParamSize.ResourceIds', + 'errorMessage' => 'The number of Param ResourceIds exceeded the limit.', + 'description' => '传入的ResourceIds参数超过数量限制。', + ], + [ + 'errorCode' => 'IllegalParamSize.Tags', + 'errorMessage' => 'The number of Parameter Tags exceeded the limit.', + 'description' => '传入的Tags参数超过数量限制。', + ], + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'The input parameter ResourceIds that is mandatory for processing this request is not supplied.', + 'description' => '参数ResourceIds未传入。', + ], + [ + 'errorCode' => 'MissingParameter.ResourceType', + 'errorMessage' => 'The input parameter ResourceType that is mandatory for processing this request is not supplied.', + 'description' => '参数ResourceType未传入。'."\n", + ], + [ + 'errorCode' => 'MissingParameter.TagsAndResourceIds', + 'errorMessage' => 'The input parameter Tags and ResourceIds that is mandatory for processing this request is not supplied.', + 'description' => '参数Tags及ResourceIds未传入。'."\n", + ], + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'The input parameter Tags that is mandatory for processing this request is not supplied.', + 'description' => '参数Tags未传入。'."\n", + ], + [ + 'errorCode' => 'DuplicatedParam.TagKey', + 'errorMessage' => 'TagKey duplicate.', + 'description' => 'TagKey参数重复。', + ], + [ + 'errorCode' => 'IllegalParam.TagKey', + 'errorMessage' => 'The input parameter TagKey is invalid.', + 'description' => '参数TagKey非法。'."\n", + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '查询资源已绑定的标签列表', + 'summary' => '查询资源标签列表。', + 'description' => '### 使用说明'."\n" + ."\n" + .'- 请求中至少指定参数**ResourceId.N**或**Tag.N**（**Tag.N.Key**与**Tag.N.Value**），以确定检索对象。'."\n" + .'- **Tag.N**是资源的标签，由一个键值对组成。仅指定**Tag.N.Key**时，则返回该标签键关联的所有标签值。仅指定**Tag.N.Value**会报错。'."\n" + .'- 如果您同时指定**Tag.N**和**ResourceId.N**筛选标签，则**ResourceId.N**必须满足所有输入的标签键值对。'."\n" + .'- 如果您同时指定多个标签键值对，返回结果为同时包含被指定的多个键值对的资源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListTagResources', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'vpc:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'conditional', + 'product' => 'VpcIpam', + 'resourceType' => 'Ipam', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}', + ], + [ + 'validationType' => 'conditional', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamPool', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}', + ], + [ + 'validationType' => 'conditional', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamScope', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"FinanceDept\\",\\n \\"TagValue\\": \\"FinanceJoshua\\",\\n \\"ResourceId\\": \\"ipam-uq5dcfc2eqhpf4****\\",\\n \\"ResourceType\\": \\"IPAM\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"RequestId\\": \\"672053AB-90C9-5693-AB96-458F137A5ED6\\"\\n}","type":"json"}]', + ], + 'OpenVpcIpamService' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + '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' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3F814C37-B032-5477-AF5A-2925D0593CD4', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'IPAM开通成功返回的信息。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationFailed.ExceedPurchaseLimit', + 'errorMessage' => 'You have reached the limit of purchase quantity.', + 'description' => '您已达到购买数量限制。', + ], + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'The user is not authorized to operate on the specified resource, or the API operation does not support RAM.', + 'description' => '用户没有权限对指定资源进行操作，或者该API操作不支持RAM。', + ], + [ + 'errorCode' => 'OperationFailed.AliGroupUserCanNotBuyInnerCommodity', + 'errorMessage' => 'IPAM has no group cloud product label, and users within the group are not allowed to purchase.', + 'description' => 'IPAM 无集团上云商品标签，不允许集团内部用户购买。', + ], + [ + 'errorCode' => 'Order.NoRealNameAuthentication', + 'errorMessage' => 'Real-name verification has not been completed for the account.', + 'description' => '您尚未进行实名认证，请前往账号中心完成实名认证。', + ], + [ + 'errorCode' => 'OperationFailed.BasicInfoUncompleted', + 'errorMessage' => 'You have not completed your basic personal information, please complete the information and try again.', + 'description' => '您未完善个人基本信息，请完善信息后重新操作。', + ], + [ + 'errorCode' => 'OperationFailed.AccountBalanceInsufficient', + 'errorMessage' => 'The account balance of this user is insufficient to place the order.', + 'description' => '账号余额不足。', + ], + ], + ], + 'title' => '开通IPAM功能', + 'summary' => '开通IPAM功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'OpenVpcIpamService', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'vpc:OpenVpcIpamService', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F814C37-B032-5477-AF5A-2925D0593CD4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]', + ], + 'RemoveIpamMembers' => [ + 'summary' => '移除IPAM可信服务纳管成员。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会移除IPAM可信服务纳管成员。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并移除IPAM可信服务纳管成员。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。说明 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Members', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'IPAM可信服务纳管成员。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MemberId' => [ + 'description' => '成员ID。'."\n" + ."\n" + .'- **Folder ID**：资源夹ID。'."\n" + ."\n" + .'- **Account UID**：资源目录成员账号UID。', + 'type' => 'string', + 'required' => false, + 'example' => 'Folder', + ], + 'MemberType' => [ + 'description' => '成员类型，取值：'."\n" + ."\n" + .'- **Folder**：资源夹。'."\n" + ."\n" + .'- **Account**：资源目录成员账号。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Account' => '资源目录成员账号', + 'Folder' => '资源夹', + ], + 'example' => 'fd-ccccncASqa', + 'enum' => [ + 'Account', + 'Folder', + ], + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => 'BaseResult', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3F814C37-B032-5477-AF5A-2925D0593CD4', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.MemberIdNotMatchMemberType', + 'errorMessage' => 'The operation is not allowed because the Member ID and Member Type of members [%s] in the input parameters do not match.', + 'description' => '入参Members中[%s]的Member Id和Member Type不匹配。', + ], + [ + 'errorCode' => 'OperationDenied.IpamRDServiceMemberNotExist', + 'errorMessage' => 'The operation is not allowed because %s is not managed by the IPAM.', + 'description' => '入参中待移除member %s 未被IPAM可信服务纳管。', + ], + [ + 'errorCode' => 'OperationDenied.IpamRDServiceNotEnableInOperationRegion', + 'errorMessage' => 'The operation is not allowed because the IPAM RD service is not enabled in the current region.', + 'description' => '操作地域的IPAM实例没有纳管任何资源目录成员。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '移除IPAM可信服务纳管成员', + 'description' => '- IPAM委派管理员移除最后一个纳管成员后，资源目录IPAM可信服务关闭。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F814C37-B032-5477-AF5A-2925D0593CD4\\"\\n}","type":"json"}]', + ], + 'TagResources' => [ + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。最多支持输入20个资源ID。'."\n" + ."\n" + .'> 调用该API时，ResourceId.N参数必须输入。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-uq5dcfc2eqhpf4****', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- **IPAM**：表示资源类型为IPAM。'."\n" + .'- **IPAMSCOPE**：表示资源类型为IPAM作用范围。'."\n" + .'- **IPAMPOOL**：表示资源类型为IPAM地址池。', + 'type' => 'string', + 'required' => true, + 'example' => 'IPAM', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '资源的标签键。最多支持输入20个标签键。一旦传入该值，则不允许为空字符串。'."\n" + ."\n" + .'最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'Value' => [ + 'description' => '资源的标签值。最多支持输入20个标签值。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'最多支持128个字符，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceJoshua', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BF872550-9700-52FD-839C-4D3F05543FA8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'The input parameter ResourceIds that is mandatory for processing this request is not supplied.', + 'description' => '参数ResourceIds未传入。', + ], + [ + 'errorCode' => 'MissingParameter.ResourceType', + 'errorMessage' => 'The input parameter ResourceType that is mandatory for processing this request is not supplied.', + 'description' => '参数ResourceType未传入。'."\n", + ], + [ + 'errorCode' => 'MissingParameter.TagKey', + 'errorMessage' => 'The input parameter TagKey that is mandatory for processing this request is not supplied.', + 'description' => '参数TagKey未传入。'."\n", + ], + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'The input parameter Tags that is mandatory for processing this request is not supplied.', + 'description' => '参数Tags未传入。'."\n", + ], + [ + 'errorCode' => 'MissingParameter.TagValue', + 'errorMessage' => 'The input parameter TagValue that is mandatory for processing this request is not supplied.', + 'description' => '参数TagValue未传入。'."\n", + ], + [ + 'errorCode' => 'IllegalParamSize.ResourceIds', + 'errorMessage' => 'The number of Param ResourceIds exceeded the limit.', + 'description' => '传入的ResourceIds参数超过数量限制。', + ], + [ + 'errorCode' => 'IllegalParamSize.Tags', + 'errorMessage' => 'The number of Parameter Tags exceeded the limit.', + 'description' => '传入的Tags参数超过数量限制。', + ], + [ + 'errorCode' => 'DuplicatedParam.TagKey', + 'errorMessage' => 'TagKey duplicate.', + 'description' => 'TagKey参数重复。', + ], + [ + 'errorCode' => 'ResourceNotFound.Ipam', + 'errorMessage' => 'The specified resource of ipam is not found.', + 'description' => '输入的IPAM不存在。', + ], + [ + 'errorCode' => 'ResourceNotFound.IpamScope', + 'errorMessage' => 'The specified resource of IPAM scope is not found.', + 'description' => '输入的IPAM作用范围不存在。', + ], + [ + 'errorCode' => 'IllegalParam.TagKey', + 'errorMessage' => 'The input parameter TagKey is invalid.', + 'description' => '参数TagKey非法。'."\n", + ], + [ + 'errorCode' => 'DuplicatedParam.ResourceIds', + 'errorMessage' => 'The parameter of ResourceIds contains duplicate values.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '为IPAM资源创建并绑定标签', + 'summary' => '为资源实例绑定资源标签。', + 'description' => '### 使用说明'."\n" + .'标签是您为实例分配的标记，每个标签都由一对键值对（Key-Value）组成。标签的使用说明如下：'."\n" + ."\n" + .'- 一个实例上的每条标签的标签键（Key）必须唯一。'."\n" + .'- 不支持未绑定实例的空标签存在，标签必须绑定在实例上。'."\n" + .'- 单个实例最多可绑定20条标签。绑定标签前，阿里云会校验资源已有标签数量。超过限制值后返回报错信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'TagResources', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'conditional', + 'product' => 'VpcIpam', + 'resourceType' => 'Ipam', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}', + ], + [ + 'validationType' => 'conditional', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamPool', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}', + ], + [ + 'validationType' => 'conditional', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamScope', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF872550-9700-52FD-839C-4D3F05543FA8\\"\\n}","type":"json"}]', + ], + 'UntagResources' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源的地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。最多支持解绑20个资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipam-uq5dcfc2eqhpf4****', + ], + 'required' => true, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '资源类型。取值：'."\n" + ."\n" + .'- **IPAM**：表示资源类型为IPAM。'."\n" + .'- **IPAMSCOPE**：表示资源类型为IPAM作用范围。'."\n" + .'- **IPAMPOOL**：表示资源类型为IPAM地址池。', + 'type' => 'string', + 'required' => true, + 'example' => 'IPAM', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '要解绑的标签键列表。', + 'type' => 'array', + 'items' => [ + 'description' => '要解绑的标签键。最多支持输入20个标签键。一旦传入该值，可以为空字符串。'."\n" + ."\n" + .'一个标签键最多支持64个字符，必须以字母或中文开头，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'FinanceDept', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否解绑资源的所有标签。取值：'."\n" + ."\n" + .'- **true**：解除资源的所有标签。'."\n" + .'- **false**（默认值）：不解除资源的所有标签。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '44C884BD-2D56-5637-A523-1FA920A01E7D', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'MissingParameter.ResourceIds', + 'errorMessage' => 'The input parameter ResourceIds that is mandatory for processing this request is not supplied.', + 'description' => '参数ResourceIds未传入。', + ], + [ + 'errorCode' => 'MissingParameter.ResourceType', + 'errorMessage' => 'The input parameter ResourceType that is mandatory for processing this request is not supplied.', + 'description' => '参数ResourceType未传入。'."\n", + ], + [ + 'errorCode' => 'IllegalParamSize.ResourceIds', + 'errorMessage' => 'The number of Param ResourceIds exceeded the limit.', + 'description' => '传入的ResourceIds参数超过数量限制。', + ], + [ + 'errorCode' => 'IllegalParamSize.Tags', + 'errorMessage' => 'The number of Parameter Tags exceeded the limit.', + 'description' => '传入的Tags参数超过数量限制。', + ], + [ + 'errorCode' => 'IllegalParam.ResourceType', + 'errorMessage' => 'The input parameter ResourceType is invalid.', + 'description' => '参数ResourceType非法。'."\n", + ], + [ + 'errorCode' => 'MissingParameter.Tags', + 'errorMessage' => 'The input parameter Tags that is mandatory for processing this request is not supplied.', + 'description' => '参数Tags未传入。'."\n", + ], + [ + 'errorCode' => 'IllegalParam.TagKey', + 'errorMessage' => 'The input parameter TagKey is invalid.', + 'description' => '参数TagKey非法。'."\n", + ], + [ + 'errorCode' => 'ResourceNotFound.Ipam', + 'errorMessage' => 'The specified resource of ipam is not found.', + 'description' => '输入的IPAM不存在。', + ], + [ + 'errorCode' => 'ResourceNotFound.IpamScope', + 'errorMessage' => 'The specified resource of IPAM scope is not found.', + 'description' => '输入的IPAM作用范围不存在。', + ], + [ + 'errorCode' => 'DuplicatedParam.ResourceIds', + 'errorMessage' => 'The parameter of ResourceIds contains duplicate values.', + 'description' => '', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '为IPAM资源解绑标签', + 'summary' => '为资源解绑资源标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UntagResources', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'conditional', + 'product' => 'VpcIpam', + 'resourceType' => 'Ipam', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}', + ], + [ + 'validationType' => 'conditional', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamPool', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}', + ], + [ + 'validationType' => 'conditional', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamScope', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"44C884BD-2D56-5637-A523-1FA920A01E7D\\"\\n}","type":"json"}]', + ], + 'UpdateIpam' => [ + 'summary' => '修改IPAM实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-ccxbnsbhew0d6t****', + ], + ], + [ + 'name' => 'IpamName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpamDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM的描述信息。'."\n" + ."\n\n" + .'长度为1～256个字符，必须以英文大小写字母或中文开头。但不能以`http://`或`https://`开头。默认为空，不填则为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'AddOperatingRegion', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '为IPAM添加的生效地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '为IPAM添加的生效地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'eu-central-1', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'RemoveOperatingRegion', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '为IPAM移除的生效地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '为IPAM移除的生效地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会修改IPAM实例。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并修改IPAM实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'F4650E33-895C-53F0-9CD5-D1338F322DE8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotFound.Ipam', + 'errorMessage' => 'The specified resource of ipam is not found.', + 'description' => '输入的IPAM不存在。', + ], + [ + 'errorCode' => 'IllegalParam.OperatingRegion', + 'errorMessage' => 'The operating region is invalid.', + 'description' => '生效地域非法。', + ], + [ + 'errorCode' => 'DependencyViolation.IpamPool', + 'errorMessage' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', + 'description' => '指定的资源被其他的资源依赖，不允许进行当前操作。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.IpamRegionCannotBeRemoved', + 'errorMessage' => 'The IPAM region cannot be removed.', + 'description' => '不能移除IPAM托管地域。', + ], + ], + ], + 'title' => '修改IPAM实例', + 'description' => '- 为IPAM实例移除生效地域时，不能包含IPAM托管地域。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpam', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:UpdateIpam', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'Ipam', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F4650E33-895C-53F0-9CD5-D1338F322DE8\\"\\n}","type":"json"}]', + ], + 'UpdateIpamPool' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~448570~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamPoolId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-6rcq3tobayc20t****', + ], + ], + [ + 'name' => 'IpamPoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的IPAM地址池的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpamPoolDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的IPAM地址池的描述信息。'."\n" + ."\n" + .'长度为1～256个字符，必须以大小写英文字母或中文字符开头，但不能以`http://`或`https://`开头。不填则为空，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'AllocationDefaultCidrMask', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的IPAM地址池默认网络掩码。'."\n" + ."\n" + .'取值范围：**0~32**位。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '28', + ], + ], + [ + 'name' => 'AllocationMaxCidrMask', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的IPAM地址池最大网络掩码。'."\n" + ."\n" + .'取值范围：**0~32**位。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '32', + ], + ], + [ + 'name' => 'AllocationMinCidrMask', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的IPAM地址池最小网络掩码。'."\n" + ."\n" + .'取值范围：**0~32**位。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '8', + ], + ], + [ + 'name' => 'ClearAllocationDefaultCidrMask', + 'in' => 'query', + 'schema' => [ + 'description' => '是否清除IPAM地址池默认网络掩码。取值：'."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会修改IPAM地址池信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接修改。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'AutoImport', + 'in' => 'query', + 'schema' => [ + 'description' => '地址池是否开启自动导入功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9DED57B9-7654-5B6D-93F7-BCA5839FEE38', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OperationDenied.PoolRegionNotSupportUpdatePool', + 'errorMessage' => 'The operation is not allowed because of pool region not support update.', + 'description' => '操作被拒绝，原因是无法在该地域执行更新地址池操作。', + ], + [ + 'errorCode' => 'IllegalParam.AllocationDefaultNetmask', + 'errorMessage' => 'The specified AllocationDefaultNetmask is illegal.', + 'description' => 'AllocationDefaultNetmask参数不合法。'."\n", + ], + [ + 'errorCode' => 'IllegalParam.AllocationMaxNetmask', + 'errorMessage' => 'The specified AllocationMaxNetmask is illegal.', + 'description' => 'AllocationMaxNetmask参数不合法。'."\n", + ], + [ + 'errorCode' => 'IllegalParam.AllocationMinNetmask', + 'errorMessage' => 'The specified AllocationMinNetmask is illegal.', + 'description' => 'AllocationMinNetmask参数不合法。'."\n", + ], + [ + 'errorCode' => 'IllegalParam.IpVersion', + 'errorMessage' => 'The specified IpVersion is illegal.', + 'description' => 'IpVersion参数不合法。'."\n", + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.OperateShareResource', + 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', + 'description' => '该实例是共享资源，不允许操作。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + ], + ], + 'title' => '修改IPAM地址池信息', + 'summary' => '修改IPAM地址池基本信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpamPool', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:UpdateIpamPool', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DED57B9-7654-5B6D-93F7-BCA5839FEE38\\"\\n}","type":"json"}]', + ], + 'UpdateIpamPoolAllocation' => [ + 'summary' => '修改IPAM地址池的CIDR分配信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池CIDR分配所在的地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会修改IPAM地址池CIDR分配信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接修改IPAM地址池CIDR分配信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000'."\n", + ], + ], + [ + 'name' => 'IpamPoolAllocationDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池CIDR分配的描述信息。'."\n" + ."\n" + .'长度为1～256个字符，必须以大小写英文字母或中文字符开头，但不能以`http://`或`https://`开头。不填则为空，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'IpamPoolAllocationName', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池CIDR分配的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test name', + ], + ], + [ + 'name' => 'IpamPoolAllocationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM地址池CIDR分配的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-pool-alloc-112za33e4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F4650E33-895C-53F0-9CD5-D1338F322DE8', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.Unauthorized', + 'errorMessage' => 'The operation is denied because the user is not authorized.', + 'description' => '操作失败，用户无权限。', + ], + [ + 'errorCode' => 'OperationDenied.RequestRegionInvalid', + 'errorMessage' => 'The operation is not allowed because the request is not invoked in the region of the IPAM pool.', + 'description' => '操作被拒绝，因为未在地址池所在地域调用请求。', + ], + ], + 404 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamPool', + 'errorMessage' => 'The dependent IPAM pool is not found.', + 'description' => '依赖资源IPAM Pool不存在。', + ], + [ + 'errorCode' => 'ResourceNotFound.IpamPoolAllocation', + 'errorMessage' => 'The specified resource of IPAM pool allocation is not found.', + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改IPAM地址池的CIDR分配信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpamPoolAllocation', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:UpdateIpamPoolAllocation', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F4650E33-895C-53F0-9CD5-D1338F322DE8\\"\\n}","type":"json"}]', + ], + 'UpdateIpamResourceDiscovery' => [ + 'summary' => '修改资源发现实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '请求地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryName', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpamResourceDiscoveryDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '资源发现的描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'AddOperatingRegion', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '为资源发现添加的生效地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '为资源发现添加的生效地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'eu-central-1', + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'RemoveOperatingRegion', + 'in' => 'query', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'description' => '为资源发现移除的生效地域列表。', + 'type' => 'array', + 'items' => [ + 'description' => '为资源发现移除的生效地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 1, + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会修改资源发现实例。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过，则返回对应错误。如果检查通过，则返回DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并修改资源发现实例。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PlainResult<IpamCreateModel>', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IllegalParam.OperatingRegion', + 'errorMessage' => 'The operating region is invalid.', + 'description' => '生效地域非法。', + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + [ + 'errorCode' => 'OperationDenied.OperateShareResource', + 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', + 'description' => '该实例是共享资源，不允许操作。', + ], + [ + 'errorCode' => 'OperationDenied.UnexpectedType', + 'errorMessage' => 'The operation is not allowed because the input type is unexpected.', + 'description' => '更新或删除资源发现时，不允许操作system类型的实例。', + ], + [ + 'errorCode' => 'OperationDenied.RemoveResourceDiscoveryHomeRegion', + 'errorMessage' => 'The home region of IPAM resource discovery cannot be removed.', + 'description' => '不能移除资源发现的中心托管地域。', + ], + [ + 'errorCode' => 'ResourceNotFound.IpamResourceDiscovery', + 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', + 'description' => '未找到IPAM资源发现实例。', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'title' => '修改资源发现实例', + 'description' => '- 只允许为自定义类型的资源发现实例添加或移除生效地域。'."\n" + ."\n" + .'- 为资源发现实例移除生效地域时，不能包含资源发现的托管地域。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpamResourceDiscovery', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:UpdateIpamResourceDiscovery', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => 'IpamResourceDiscovery', + 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamresourcediscovery/{#IpamResourceDiscoveryId}', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\"\\n}","type":"json"}]', + ], + 'UpdateIpamScope' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM托管地域ID。您可以通过调用[DescribeRegions](~~36063~~)接口获取地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'IpamScopeId', + 'in' => 'query', + 'schema' => [ + 'description' => 'IPAM作用范围实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ipam-scope-glfmcyldpm8lsy****', + ], + ], + [ + 'name' => 'IpamScopeName', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的IPAM作用范围的名称。'."\n" + ."\n" + .'长度为1～128个字符，不能以`http://`或`https://`开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'IpamScopeDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的IPAM作用范围的描述信息。'."\n" + ."\n" + .'长度为1～256个字符，必须以英文大小写字母开头，但不能以`http://`或`https://`开头。不填则为空，默认值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'description' => '是否只预检此次请求。取值：'."\n" + ."\n" + .'- **true**：发送检查请求，不会修改IPAM作用范围信息。检查项包括是否填写了必需参数、请求格式、实例状态。如果检查不通过，则返回对应错误。如果检查通过，则返回DryRunOperation。'."\n" + .'- **false**（默认值）：发送正常请求，通过检查后返回HTTP 2xx状态码并直接进行修改。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。'."\n" + ."\n" + .'> 若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'BaseResult', + 'description' => '返回的信息列表。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BA8054F5-852A-570A-ACFF-BCA63E0B02D5', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ResourceNotFound.IpamScope', + 'errorMessage' => 'The specified resource of IPAM scope is not found.', + 'description' => '输入的IPAM作用范围不存在。', + ], + [ + 'errorCode' => 'IncorrectStatus.IpamScope', + 'errorMessage' => 'The status of the IPAM scope is incorrect.', + 'description' => 'IPAM作用范围的状态不正确。'."\n", + ], + [ + 'errorCode' => 'DryRunOperation', + 'errorMessage' => 'Request validation has been passed with DryRun flag set.', + 'description' => 'DryRun校验通过。', + ], + ], + ], + 'title' => '修改IPAM作用范围的信息', + 'summary' => '修改IPAM作用范围的基本信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpamScope', + ], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'vpc:UpdateIpamScope', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + [ + 'validationType' => 'always', + 'product' => 'VpcIpam', + 'resourceType' => '全部资源', + 'arn' => '*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA8054F5-852A-570A-ACFF-BCA63E0B02D5\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-northeast-1', + 'regionName' => '日本（东京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.ap-northeast-1.aliyuncs.com', + 'endpoint' => 'vpcipam.ap-northeast-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'ap-northeast-2', + 'regionName' => '韩国（首尔）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.ap-northeast-2.aliyuncs.com', + 'endpoint' => 'vpcipam.ap-northeast-2.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'ap-southeast-1', + 'regionName' => '新加坡', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.ap-southeast-1.aliyuncs.com', + 'endpoint' => 'vpcipam.ap-southeast-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'ap-southeast-2', + 'regionName' => '澳大利亚（悉尼）已关停', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.ap-southeast-2.aliyuncs.com', + 'endpoint' => 'vpcipam.ap-southeast-2.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'ap-southeast-3', + 'regionName' => '马来西亚（吉隆坡）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.ap-southeast-3.aliyuncs.com', + 'endpoint' => 'vpcipam.ap-southeast-3.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'ap-southeast-5', + 'regionName' => '印度尼西亚（雅加达）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.ap-southeast-5.aliyuncs.com', + 'endpoint' => 'vpcipam.ap-southeast-5.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'ap-southeast-6', + 'regionName' => '菲律宾（马尼拉）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.ap-southeast-6.aliyuncs.com', + 'endpoint' => 'vpcipam.ap-southeast-6.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'ap-southeast-7', + 'regionName' => '泰国（曼谷）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.ap-southeast-7.aliyuncs.com', + 'endpoint' => 'vpcipam.ap-southeast-7.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-beijing', + 'regionName' => '华北2（北京）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-beijing.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-beijing.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-chengdu', + 'regionName' => '西南1（成都）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-chengdu.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-chengdu.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-fuzhou', + 'regionName' => '华东6（福州-本地地域）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-fuzhou.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-fuzhou.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-guangzhou', + 'regionName' => '华南3（广州）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-guangzhou.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-guangzhou.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-hangzhou', + 'regionName' => '华东1（杭州）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-hangzhou.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-hangzhou.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-heyuan', + 'regionName' => '华南2（河源）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-heyuan.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-heyuan.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-hongkong', + 'regionName' => '中国香港', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-hongkong.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-hongkong.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-huhehaote', + 'regionName' => '华北5（呼和浩特）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-huhehaote.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-huhehaote.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-nanjing', + 'regionName' => '华东5（南京-本地地域）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-nanjing.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-nanjing.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-qingdao', + 'regionName' => '华北1（青岛）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-qingdao.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-qingdao.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-shanghai', + 'regionName' => '华东2（上海）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-shanghai.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-shanghai.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-shenzhen', + 'regionName' => '华南1（深圳）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-shenzhen.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-shenzhen.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'regionName' => '华中1（武汉-本地地域）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-wuhan-lr.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-wuhan-lr.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'regionName' => '华北6（乌兰察布）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-wulanchabu.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-wulanchabu.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'regionName' => '华北3（张家口）', + 'areaId' => 'asiaPacific', + 'areaName' => '亚太', + 'public' => 'vpcipam.cn-zhangjiakou.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-zhangjiakou.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'us-west-1', + 'regionName' => '美国（硅谷）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + 'public' => 'vpcipam.us-west-1.aliyuncs.com', + 'endpoint' => 'vpcipam.us-west-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'us-east-1', + 'regionName' => '美国（弗吉尼亚）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + 'public' => 'vpcipam.us-east-1.aliyuncs.com', + 'endpoint' => 'vpcipam.us-east-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'eu-west-1', + 'regionName' => '英国（伦敦）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + 'public' => 'vpcipam.eu-west-1.aliyuncs.com', + 'endpoint' => 'vpcipam.eu-west-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'eu-central-1', + 'regionName' => '德国（法兰克福）', + 'areaId' => 'europeAmerica', + 'areaName' => '欧洲与美洲', + 'public' => 'vpcipam.eu-central-1.aliyuncs.com', + 'endpoint' => 'vpcipam.eu-central-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'me-east-1', + 'regionName' => '阿联酋（迪拜）', + 'areaId' => 'middleEast', + 'areaName' => '中东', + 'public' => 'vpcipam.me-east-1.aliyuncs.com', + 'endpoint' => 'vpcipam.me-east-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'me-central-1', + 'regionName' => '沙特（利雅得）', + 'areaId' => 'middleEast', + 'areaName' => '中东', + 'public' => 'vpcipam.me-central-1.aliyuncs.com', + 'endpoint' => 'vpcipam.me-central-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'regionName' => '华南1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + 'public' => 'vpcipam.cn-shenzhen-finance-1.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-shenzhen-finance-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'regionName' => '华东2 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + 'public' => 'vpcipam.cn-shanghai-finance-1.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-shanghai-finance-1.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'regionName' => '华东1 金融云', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + 'public' => 'vpcipam.cn-hangzhou-finance.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-hangzhou-finance.aliyuncs.com', + 'vpc' => '', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'regionName' => '华北2 金融云（邀测）', + 'areaId' => 'industryCloud', + 'areaName' => '行业云', + 'public' => 'vpcipam.cn-beijing-finance-1.aliyuncs.com', + 'endpoint' => 'vpcipam.cn-beijing-finance-1.aliyuncs.com', + 'vpc' => '', + ], + ], + 'errorCodes' => [ + [ + 'code' => 'DependencyViolation.CustomCidrs', + 'message' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', + 'http_code' => 400, + 'description' => '指定的资源被其他的资源依赖，不允许进行当前操作。'."\n", + ], + [ + 'code' => 'DependencyViolation.IpamMembers', + 'message' => 'The IPAM [%s] has managed members [%s], so the IPAM cannot be deleted.', + 'http_code' => 400, + 'description' => 'IPAM[%s]存在纳管成员[%s]，此IPAM不允许删除。', + ], + [ + 'code' => 'DependencyViolation.IpamPool', + 'message' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', + 'http_code' => 400, + 'description' => '指定的资源被其他的资源依赖，不允许进行当前操作。', + ], + [ + 'code' => 'DependencyViolation.ShareResource', + 'message' => 'The specified resource of IPAM pool depends on resource sharing, so the operation cannot be completed.', + 'http_code' => 400, + 'description' => 'IPAM地址池存在共享关系，无法完成当前操作。', + ], + [ + 'code' => 'DependencyViolation.ShareResource', + 'message' => 'The operation is not allowed because the default resource discovery of this IPAM is sharing.', + 'http_code' => 400, + 'description' => '无法删除IPAM，原因是该IPAM的默认资源发现存在共享关系。', + ], + [ + 'code' => 'DependencyViolation.ShareResource', + 'message' => 'The specified resource of IPAM resource discovery depends on resource sharing, so the operation cannot be completed.', + 'http_code' => 400, + 'description' => 'IPAM资源发现存在共享关系，无法完成当前操作。', + ], + [ + 'code' => 'DependencyViolation.SubCidr', + 'message' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', + 'http_code' => 400, + 'description' => '指定的资源被其他的资源依赖，不允许进行当前操作。'."\n", + ], + [ + 'code' => 'DryRunOperation', + 'message' => 'Request validation has been passed with DryRun flag set.', + 'http_code' => 400, + 'description' => 'DryRun校验通过。', + ], + [ + 'code' => 'DuplicatedParam.TagKey', + 'message' => 'TagKey duplicate.', + 'http_code' => 400, + 'description' => 'TagKey参数重复。', + ], + [ + 'code' => 'Forbidden.IpResourceAccess', + 'message' => 'The IPAM resource discovery instance in the parameters is not allowed to access the IP address of resource %s.', + 'http_code' => 400, + 'description' => '入参中的资源发现实例不允许访问资源%s的IP address信息。', + ], + [ + 'code' => 'Forbidden.QueryShareResource', + 'message' => 'Authentication is failed for querying a shared IPAM pool.', + 'http_code' => 400, + 'description' => '查询共享IPAM地址池的资源失败。', + ], + [ + 'code' => 'Forbidden.RAM', + 'message' => 'The user is not authorized to operate on the specified resource, or the API operation does not support RAM.', + 'http_code' => 400, + 'description' => '用户没有权限对指定资源进行操作，或者该API操作不支持RAM。', + ], + [ + 'code' => 'Forbidden.SubPool', + 'message' => 'The IPAM pool contains subpools.', + 'http_code' => 400, + 'description' => 'IPAM地址池中含有子池，不允许删除。', + ], + [ + 'code' => 'IllegalParam.AllocationDefaultNetmask', + 'message' => 'The specified AllocationDefaultNetmask is illegal.', + 'http_code' => 400, + 'description' => 'AllocationDefaultNetmask参数不合法。'."\n", + ], + [ + 'code' => 'IllegalParam.AllocationMaxNetmask', + 'message' => 'The specified AllocationMaxNetmask is illegal.', + 'http_code' => 400, + 'description' => 'AllocationMaxNetmask参数不合法。'."\n", + ], + [ + 'code' => 'IllegalParam.AllocationMinNetmask', + 'message' => 'The specified AllocationMinNetmask is illegal.', + 'http_code' => 400, + 'description' => 'AllocationMinNetmask参数不合法。'."\n", + ], + [ + 'code' => 'IllegalParam.Cidr', + 'message' => 'The specified CIDR is illegal.', + 'http_code' => 400, + 'description' => '指定的CIDR不合法。', + ], + [ + 'code' => 'IllegalParam.CidrMask', + 'message' => 'The specified CidrMask is illegal.', + 'http_code' => 400, + 'description' => 'CidrMask参数不合法。', + ], + [ + 'code' => 'IllegalParam.IpamPool', + 'message' => 'The specified IPAM pool cannot be empty.', + 'http_code' => 400, + 'description' => 'IPAM Pool不可以为空。', + ], + [ + 'code' => 'IllegalParam.Ipv6Isp', + 'message' => 'The specified Ipv6Isp is illegal.', + 'http_code' => 400, + 'description' => '指定的Ipv6Isp参数不合法。', + ], + [ + 'code' => 'IllegalParam.IpVersion', + 'message' => 'The specified IpVersion is illegal.', + 'http_code' => 400, + 'description' => 'IpVersion参数不合法。'."\n", + ], + [ + 'code' => 'IllegalParam.NetmaskLength', + 'message' => 'The specified NetmaskLength is illegal.', + 'http_code' => 400, + 'description' => 'NetmaskLength参数不合法。', + ], + [ + 'code' => 'IllegalParam.OperatingRegion', + 'message' => 'The operating region is invalid.', + 'http_code' => 400, + 'description' => '生效地域非法。', + ], + [ + 'code' => 'IllegalParam.PoolRegionId', + 'message' => 'The specified PoolRegionId is illegal.', + 'http_code' => 400, + 'description' => 'PoolRegionId参数不合法。'."\n", + ], + [ + 'code' => 'IllegalParam.ResourceGroupId', + 'message' => 'The input parameter ResourceGroupId is invalid.', + 'http_code' => 400, + 'description' => '参数ResourceGroupId非法。'."\n", + ], + [ + 'code' => 'IllegalParam.ResourceRegion', + 'message' => 'The input parameter ResourceRegionId is invalid.', + 'http_code' => 400, + 'description' => '输入的参数ResourceRegionId未在操作地域中。', + ], + [ + 'code' => 'IllegalParam.ResourceType', + 'message' => 'The input parameter ResourceType is invalid.', + 'http_code' => 400, + 'description' => '参数ResourceType非法。'."\n", + ], + [ + 'code' => 'IllegalParam.TagKey', + 'message' => 'The input parameter TagKey is invalid.', + 'http_code' => 400, + 'description' => '参数TagKey非法。'."\n", + ], + [ + 'code' => 'IllegalParamFormat.%s', + 'message' => 'The param of %s is illegal.', + 'http_code' => 400, + 'description' => '参数%s不合法。', + ], + [ + 'code' => 'IllegalParamSize.ResourceIds', + 'message' => 'The number of Param ResourceIds exceeded the limit.', + 'http_code' => 400, + 'description' => '传入的ResourceIds参数超过数量限制。', + ], + [ + 'code' => 'IllegalParamSize.Tags', + 'message' => 'The number of Parameter Tags exceeded the limit.', + 'http_code' => 400, + 'description' => '传入的Tags参数超过数量限制。', + ], + [ + 'code' => 'IncorrectStatus.IpamPool', + 'message' => 'The status of the IPAM pool is incorrect.', + 'http_code' => 400, + 'description' => 'IPAM地址池的状态不正确。', + ], + [ + 'code' => 'IncorrectStatus.IpamResourceDiscovery', + 'message' => 'The status of the IPAM resource discovery is incorrect.', + 'http_code' => 400, + 'description' => 'IPAM资源发现的状态不正确。', + ], + [ + 'code' => 'IncorrectStatus.IpamScope', + 'message' => 'The status of the IPAM scope is incorrect.', + 'http_code' => 400, + 'description' => 'IPAM作用范围的状态不正确。'."\n", + ], + [ + 'code' => 'Mismatch.CidrAndNetmaskLength', + 'message' => 'The mask of the input Cidr is inconsistent with the input NetmaskLength.', + 'http_code' => 400, + 'description' => '输入的Cidr的掩码值和输入的NetmaskLength不一致。', + ], + [ + 'code' => 'Mismatch.CidrAndPoolIpVersion', + 'message' => 'The ip verion of input Cidr is inconsistent with that of the input IPAM pool.', + 'http_code' => 400, + 'description' => '输入的Cidr的IP地址协议版本与输入的IPAM地址池的IP地址协议版本不一致。', + ], + [ + 'code' => 'Mismatch.IpamResourceDiscoveryAndResource', + 'message' => 'The IPAM resource discovery %s and the queried %s do not match.', + 'http_code' => 400, + 'description' => '资源发现实例%s和所查询资源%s不匹配。', + ], + [ + 'code' => 'Mismatch.IpamScopeAndSourceIpamPool', + 'message' => 'The input source IPAM pool is not in the input IPAM scope.', + 'http_code' => 400, + 'description' => '输入的IPAM父池不在输入的IPAM作用范围内。', + ], + [ + 'code' => 'Mismatch.Ipv6IspAndSourceIpamPool', + 'message' => 'The input Ipv6Isp is inconsistent with the Ipv6Isp of the input source IPAM pool.', + 'http_code' => 400, + 'description' => '输入的Ipv6Isp和父池的Ipv6Isp不一致。', + ], + [ + 'code' => 'Mismatch.VpcIdAndVSwitchId', + 'message' => 'VpcId and VSwitchId do not match.', + 'http_code' => 400, + 'description' => 'VpcId和VSwitchId不匹配。', + ], + [ + 'code' => 'MissingParam.Cidr', + 'message' => 'The Cidr must be input when adding CIDR for IPAM private top pool.', + 'http_code' => 400, + 'description' => '为IPAM私网顶级池预置地址段时，请输入Cidr。', + ], + [ + 'code' => 'MissingParam.CidrOrCidrMask', + 'message' => 'The CIDR or CIDR Mask must be input.', + 'http_code' => 400, + 'description' => '从IPAM地址池分配资源或查询可用资源时，请输入Cidr或CidrMask。', + ], + [ + 'code' => 'MissingParam.CidrOrNetmaskLength', + 'message' => 'The Cidr or NetmaskLength must be input.', + 'http_code' => 400, + 'description' => '为IPAM地址池预置地址段时，请输入Cidr或NetmaskLength。', + ], + [ + 'code' => 'MissingParam.IpamResourceDiscoveryId', + 'message' => 'The IpamResourceDiscoveryId must be input.', + 'http_code' => 400, + 'description' => '查询发现的资源时，请输入参数IpamResourceDiscoveryId。', + ], + [ + 'code' => 'MissingParam.ResourceRegionId', + 'message' => 'The ResourceRegionId must be input.', + 'http_code' => 400, + 'description' => '查询发现的资源时，请输入参数ResourceRegionId。', + ], + [ + 'code' => 'MissingParam.VpcIdAndVSwitchId', + 'message' => 'VpcId and VSwitchId cannot both be empty please provide at least one.', + 'http_code' => 400, + 'description' => '入参VpcId和VSwitchId不能均为空值，至少填入其中一个。', + ], + [ + 'code' => 'MissingParameter.ResourceIds', + 'message' => 'The input parameter ResourceIds that is mandatory for processing this request is not supplied.', + 'http_code' => 400, + 'description' => '参数ResourceIds未传入。', + ], + [ + 'code' => 'MissingParameter.ResourceType', + 'message' => 'The input parameter ResourceType that is mandatory for processing this request is not supplied.', + 'http_code' => 400, + 'description' => '参数ResourceType未传入。'."\n", + ], + [ + 'code' => 'MissingParameter.TagKey', + 'message' => 'The input parameter TagKey that is mandatory for processing this request is not supplied.', + 'http_code' => 400, + 'description' => '参数TagKey未传入。'."\n", + ], + [ + 'code' => 'MissingParameter.Tags', + 'message' => 'The input parameter Tags that is mandatory for processing this request is not supplied.', + 'http_code' => 400, + 'description' => '参数Tags未传入。'."\n", + ], + [ + 'code' => 'MissingParameter.TagsAndResourceIds', + 'message' => 'The input parameter Tags and ResourceIds that is mandatory for processing this request is not supplied.', + 'http_code' => 400, + 'description' => '参数Tags及ResourceIds未传入。'."\n", + ], + [ + 'code' => 'MissingParameter.TagValue', + 'message' => 'The input parameter TagValue that is mandatory for processing this request is not supplied.', + 'http_code' => 400, + 'description' => '参数TagValue未传入。'."\n", + ], + [ + 'code' => 'OperationDenied.AccountNotRDEntity', + 'message' => 'The operation is not allowed because the caller does not belong to the resource directory.', + 'http_code' => 400, + 'description' => '调用者不属于任何资源目录，不允许纳管IPAM可信服务成员。', + ], + [ + 'code' => 'OperationDenied.AutoImportNeedPoolRegion', + 'message' => 'The automatic import is not supported for the IPAM pool whose pool region is empty.', + 'http_code' => 400, + 'description' => '不支持为生效地域为空的IPAM地址池开通自动导入。', + ], + [ + 'code' => 'OperationDenied.AvailableCidrInsufficient', + 'message' => 'The operation is not allowed because available CIDR is insufficient.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是可用的CIDR资源不足。', + ], + [ + 'code' => 'OperationDenied.CidrConflictWithExistAllocation', + 'message' => 'The operation is not allowed because the input CIDR conflicts with the existing allocation.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为输入的CIDR与已分配的CIDR冲突。', + ], + [ + 'code' => 'OperationDenied.CidrConflictWithOfficialGuaCidrs', + 'message' => 'The operation is not allowed because the input CIDR conflicts with official GUA CIDRs.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为输入的CIDR与官方GUA CIDR冲突。', + ], + [ + 'code' => 'OperationDenied.CidrConflictWithTopCidrs', + 'message' => 'The operation is not allowed because the input CIDR conflicts with existing top CIDRs.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为输入的CIDR与已存在的顶级池CIDR冲突。', + ], + [ + 'code' => 'OperationDenied.CidrInExcludeCidrs', + 'message' => 'The operation is not allowed because the input CIDR is within the illegal CIDRs.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是输入的CIDR在不合法的CIDR范围内。', + ], + [ + 'code' => 'OperationDenied.CidrNotInSourceCidr', + 'message' => 'The operation is not allowed because the input CIDR is not in source CIDR.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为输入的CIDR不在父池CIDR的范围内。', + ], + [ + 'code' => 'OperationDenied.CidrUnavailableInPool', + 'message' => 'The operation is not allowed because the CIDR is unavailable in the IPAM pool.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是CIDR在IPAM地址池中不可用。', + ], + [ + 'code' => 'OperationDenied.CreateVpcOrAssociateVpcCidrBlock', + 'message' => 'The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为无法从不具备地域属性的地址池中创建VPC或为VPC添加附加网段。', + ], + [ + 'code' => 'OperationDenied.DelegateAdminAsMember', + 'message' => 'The operation is not allowed because the IPAM delegate administrator cannot be a member.', + 'http_code' => 400, + 'description' => 'IPAM委派管理员不能添加自己作为IPAM可信服务的成员。', + ], + [ + 'code' => 'OperationDenied.DeleteDefaultScope', + 'message' => 'The operation is not allowed because of deleting default scope.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是删除默认IPAM作用范围。', + ], + [ + 'code' => 'OperationDenied.DissociateSelfSystemIpamResourceDiscovery', + 'message' => 'The operation is not allowed because the default resource discovery cannot be disassociated.', + 'http_code' => 400, + 'description' => '默认资源发现不允许解除关联关系。', + ], + [ + 'code' => 'OperationDenied.IpamNotExist', + 'message' => 'The operation is not allowed because the IPAM does not exist.', + 'http_code' => 400, + 'description' => '当前地域IPAM不存在，不允许纳管IPAM可信服务成员。', + ], + [ + 'code' => 'OperationDenied.IpamPoolAllocationExist', + 'message' => 'The operation is not allowed because of the existence of IPAM pool allocation.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是存在地址池分配关系。', + ], + [ + 'code' => 'OperationDenied.IpamPoolNotInRegion', + 'message' => 'The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为无法从不具备地域属性的地址池中创建VPC或为VPC添加附加网段。', + ], + [ + 'code' => 'OperationDenied.IpamPublicIpv6PoolNeedPoolRegion', + 'message' => 'The public IPv6 pool cannot be created in IPAM when its pool region is empty.', + 'http_code' => 400, + 'description' => '不支持创建生效地域为空的公网IPv6地址池。', + ], + [ + 'code' => 'OperationDenied.IpamRDServiceAlreadyEnabledInOtherRegion', + 'message' => 'The operation is not allowed because the IPAM Resource Directory service is already enabled in another region.', + 'http_code' => 400, + 'description' => '只允许选择一个地域的一个IPAM实例纳管资源目录成员。', + ], + [ + 'code' => 'OperationDenied.IpamRDServiceMemberNotExist', + 'message' => 'The operation is not allowed because %s is not managed by the IPAM.', + 'http_code' => 400, + 'description' => '入参中待移除member %s 未被IPAM可信服务纳管。', + ], + [ + 'code' => 'OperationDenied.IpamRDServiceNotEnableInOperationRegion', + 'message' => 'The operation is not allowed because the IPAM RD service is not enabled in the current region.', + 'http_code' => 400, + 'description' => '操作地域的IPAM实例没有纳管任何资源目录成员。', + ], + [ + 'code' => 'OperationDenied.IpamRegionCannotBeRemoved', + 'message' => 'The IPAM region cannot be removed.', + 'http_code' => 400, + 'description' => '不能移除IPAM托管地域。', + ], + [ + 'code' => 'OperationDenied.IpamRegionNotSupportGetPoolAllocation', + 'message' => 'The operation is not allowed because IPAM region does not support getting the allocation.', + 'http_code' => 400, + 'description' => '无法在IPAM地域执行查询指定地址池分配的操作。', + ], + [ + 'code' => 'OperationDenied.IpamRegionNotSupportGetPoolAvailableCidr', + 'message' => 'The operation is not allowed because IPAM region does not support getting available CIDR of IPAM pool.', + 'http_code' => 400, + 'description' => '无法在IPAM地域执行获取地址池可用CIDR的操作。', + ], + [ + 'code' => 'OperationDenied.IpamRegionNotSupportListPoolAllocation', + 'message' => 'The operation is not allowed because IPAM region does not support listing allocations.', + 'http_code' => 400, + 'description' => '无法在IPAM地域执行查询地址池分配的操作。', + ], + [ + 'code' => 'OperationDenied.IpamResourceDiscoveryAlreadySharedWithAdmin', + 'message' => 'The operation is not allowed because the resource discovery has been shared with the IPAM delegated administrator by %s.', + 'http_code' => 400, + 'description' => 'IPAM可信服务不允许纳管已经将自己的资源发现共享给委派管理员的账号。', + ], + [ + 'code' => 'OperationDenied.Ipv6VpcNotSupport', + 'message' => 'The allocation of IPv6 VPC is not supported to delete.', + 'http_code' => 400, + 'description' => 'IPv6网段类型的分配不支持释放。', + ], + [ + 'code' => 'OperationDenied.MemberExistInIpamRDService', + 'message' => 'The operation is not allowed because %s is under the management of the IPAM.', + 'http_code' => 400, + 'description' => '入参中%s已经被IPAM可信服务纳管，不允许重复纳管相同的member。', + ], + [ + 'code' => 'OperationDenied.MemberIdNotMatchMemberType', + 'message' => 'The operation is not allowed because the Member ID and Member Type of members [%s] in the input parameters do not match.', + 'http_code' => 400, + 'description' => '入参Members中[%s]的Member Id和Member Type不匹配。', + ], + [ + 'code' => 'OperationDenied.NoServicePrincipalAdminPrivileges', + 'message' => 'The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory.', + 'http_code' => 400, + 'description' => '调用者不是所在资源目录的IPAM可信服务委派管理员，不允许纳管IPAM可信服务成员。', + ], + [ + 'code' => 'OperationDenied.NotDelegatedAdminAccount', + 'message' => 'The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory.', + 'http_code' => 400, + 'description' => '调用者不是所在资源目录的IPAM可信服务委派管理员，不允许纳管IPAM可信服务成员。', + ], + [ + 'code' => 'OperationDenied.OfficialCidrInsufficient', + 'message' => 'The operation is not allowed because the official CIDR is insufficient.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是官方可用的CIDR资源不足。', + ], + [ + 'code' => 'OperationDenied.OfficialCidrTmpUnavailable', + 'message' => 'The operation is not allowed because the official CIDR is temporarily unavailable.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是官方CIDR资源暂时不可用。', + ], + [ + 'code' => 'OperationDenied.OfficialCidrUnavailable', + 'message' => 'The operation is not allowed because the official CIDR is unavailable.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是CIDR已被占用。', + ], + [ + 'code' => 'OperationDenied.OperateShareResource', + 'message' => 'The operation is not allowed because the instance is a shared resource.', + 'http_code' => 400, + 'description' => '该实例是共享资源，不允许操作。', + ], + [ + 'code' => 'OperationDenied.OperatingRegionsNeedIncludeHomeRegion', + 'message' => 'The operating regions do not contain home region.', + 'http_code' => 400, + 'description' => '生效地域未包含中心托管地域。', + ], + [ + 'code' => 'OperationDenied.OwnerAlreadyManagedByRecipientIpam', + 'message' => 'The operation is not allowed because the resource owner is already managed by the resource recipient\'s IPAM.', + 'http_code' => 400, + 'description' => 'IPAM纳管成员账号不允许共享资源发现给IPAM委派管理员。', + ], + [ + 'code' => 'OperationDenied.PoolRegionNotSupportAddPoolCidr', + 'message' => 'The operation is not allowed because pool region does not support adding CIDR.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为无法在该地域执行添加地址池CIDR的操作。', + ], + [ + 'code' => 'OperationDenied.PoolRegionNotSupportDeletePool', + 'message' => 'The operation is not allowed because of pool region not support delete.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是无法在该地域执行删除地址池操作。'."\n", + ], + [ + 'code' => 'OperationDenied.PoolRegionNotSupportDeletePoolCidr', + 'message' => 'The operation is not allowed because pool region does not support deleting cidr.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是无法在该地域执行删除地址池CIDR操作。', + ], + [ + 'code' => 'OperationDenied.PoolRegionNotSupportListPoolCidr', + 'message' => 'The operation is not allowed because pool region does not support listing cidrs.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是无法在该地域执行查询地址池CIDR操作。', + ], + [ + 'code' => 'OperationDenied.PoolRegionNotSupportUpdatePool', + 'message' => 'The operation is not allowed because of pool region not support update.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是无法在该地域执行更新地址池操作。', + ], + [ + 'code' => 'OperationDenied.RemoveResourceDiscoveryHomeRegion', + 'message' => 'The home region of IPAM resource discovery cannot be removed.', + 'http_code' => 400, + 'description' => '不能移除资源发现的中心托管地域。', + ], + [ + 'code' => 'OperationDenied.RequestRegionInvalid', + 'message' => 'The operation is not allowed because the request is not invoked in the region of the IPAM pool.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为未在地址池所在地域调用请求。', + ], + [ + 'code' => 'OperationDenied.ResourceDiscoveryAlreadyAssociated', + 'message' => 'You cannot associate the resource discovery because an association already exists.', + 'http_code' => 400, + 'description' => '当前资源发现已存在关联关系，操作失败。', + ], + [ + 'code' => 'OperationDenied.ResourceRegionInvalid', + 'message' => 'The operation is denied because the resource is in a different region than the IPAM pool.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为资源所在地域与地址池所在地域不同。', + ], + [ + 'code' => 'OperationDenied.ResourceShareExist', + 'message' => 'The operation is not allowed because the resource sharing already exists.', + 'http_code' => 400, + 'description' => '资源共享已经存在，不允许操作。', + ], + [ + 'code' => 'OperationDenied.ResourceTypeIsNotCustom', + 'message' => 'The operation is not allowed because the resource type is not Custom.', + 'http_code' => 400, + 'description' => '操作被拒绝，原因是资源类型不是Custom类型。', + ], + [ + 'code' => 'OperationDenied.SharedResourceDiscoveryAssociated', + 'message' => 'The operation is not allowed because the IPAM is associated with a shared resource discovery.', + 'http_code' => 400, + 'description' => '无法删除IPAM，原因是该IPAM关联了共享的资源发现。', + ], + [ + 'code' => 'OperationDenied.SourceCidrIsNull', + 'message' => 'The operation is not allowed because the source CIDR is null.', + 'http_code' => 400, + 'description' => '操作被拒绝，因为父地址池没有CIDR.', + ], + [ + 'code' => 'OperationDenied.Unauthorized', + 'message' => 'The operation is denied because the user is not authorized.', + 'http_code' => 400, + 'description' => '操作失败，用户无权限。', + ], + [ + 'code' => 'OperationDenied.UnexpectedResourceType', + 'message' => 'The operation is not allowed because the resource type is unexpected.', + 'http_code' => 400, + 'description' => '资源类型非法，不允许操作。', + ], + [ + 'code' => 'OperationDenied.UnexpectedType', + 'message' => 'The operation is not allowed because the input type is unexpected.', + 'http_code' => 400, + 'description' => '更新或删除资源发现时，不允许操作system类型的实例。', + ], + [ + 'code' => 'OperationFailed.AccountBalanceInsufficient', + 'message' => 'The account balance of this user is insufficient to place the order.', + 'http_code' => 400, + 'description' => '账号余额不足。', + ], + [ + 'code' => 'OperationFailed.AliGroupUserCanNotBuyInnerCommodity', + 'message' => 'IPAM has no group cloud product label, and users within the group are not allowed to purchase.', + 'http_code' => 400, + 'description' => 'IPAM 无集团上云商品标签，不允许集团内部用户购买。', + ], + [ + 'code' => 'OperationFailed.BasicInfoUncompleted', + 'message' => 'You have not completed your basic personal information, please complete the information and try again.', + 'http_code' => 400, + 'description' => '您未完善个人基本信息，请完善信息后重新操作。', + ], + [ + 'code' => 'OperationFailed.ExceedPurchaseLimit', + 'message' => 'You have reached the limit of purchase quantity.', + 'http_code' => 400, + 'description' => '您已达到购买数量限制。', + ], + [ + 'code' => 'OperationFailed.IpamPoolExist', + 'message' => 'The operation is failed because user IPAM pool exist.', + 'http_code' => 400, + 'description' => '操作失败，原因是IPAM存在用户创建地址池。', + ], + [ + 'code' => 'OperationFailed.IpamScopeExist', + 'message' => 'The operation is failed because user IPAM scope exist.', + 'http_code' => 400, + 'description' => '操作失败，原因是存在用户自定义scope。', + ], + [ + 'code' => 'OperationFailed.OperatingRegionsNeedIncludeIpamRegion', + 'message' => 'The operating regions do not contain IPAM region.', + 'http_code' => 400, + 'description' => '操作地域未包含IPAM托管地域。', + ], + [ + 'code' => 'OptInRequired.Ipam', + 'message' => 'You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.', + 'http_code' => 400, + 'description' => '您无权使用请求的 IPAM 服务。 确保您已经订阅了您尝试使用的服务。', + ], + [ + 'code' => 'Order.NoRealNameAuthentication', + 'message' => 'Real-name verification has not been completed for the account.', + 'http_code' => 400, + 'description' => '您尚未进行实名认证，请前往账号中心完成实名认证。', + ], + [ + 'code' => 'QuotaExceeded.IpamCidrQuotaPerIpamPool', + 'message' => 'The quota of ipamCidrQuotaPerIpamPool count is exceeded.', + 'http_code' => 400, + 'description' => 'IPAM地址池允许的CIDR数量超过限制。', + ], + [ + 'code' => 'QuotaExceeded.IpamPoolQuotaDepth', + 'message' => 'The quota of IpamPoolQuotaDepth count is exceeded.', + 'http_code' => 400, + 'description' => 'IPAM地址池深度允许的最大数量超过限制。'."\n", + ], + [ + 'code' => 'QuotaExceeded.IpamPublicIpv6TopPoolQuotaPerRegionIsp', + 'message' => 'The number of public IPv6 top pool in IPAM for this ISP owned by the user in this region exceeds the limit.', + 'http_code' => 400, + 'description' => '对于当前的ISP类型，用户在当前地域创建的IPAM公网IPv6顶级地址池数量超过限额。', + ], + [ + 'code' => 'QuotaExceeded.IpamQuotaPerRegion', + 'message' => 'The quota of ipamQuotaPerRegion count is exceeded.', + 'http_code' => 400, + 'description' => 'IPAM允许的最大数量超过限制。', + ], + [ + 'code' => 'QuotaExceeded.IpamResourceDiscoveryQuotaPerRegion', + 'message' => 'The number of non-shared IPAM resource discoveries owned by the user in this region exceeds the limit.', + 'http_code' => 400, + 'description' => '单个用户在当前地域拥有的非共享资源发现的数量超过限额。', + ], + [ + 'code' => 'QuotaExceeded.IpamScopeQuotaPerIpam', + 'message' => 'The quota of ipamScopeQuotaPerIpam count is exceeded.', + 'http_code' => 400, + 'description' => 'IPAM作用范围允许的最大数量超过限制。', + ], + [ + 'code' => 'QuotaExceeded.IpamSubPoolQuotaPerIpamPool', + 'message' => 'The quota of ipamSubPoolQuotaPerIpamPool count is exceeded.', + 'http_code' => 400, + 'description' => '单个IPAM地址池允许创建的子池数量超过限额。', + ], + [ + 'code' => 'QuotaExceeded.MemberAccount', + 'message' => 'The operation is not allowed because the number of % managed by IPAM has exceeded the limit, %s/%s.', + 'http_code' => 400, + 'description' => 'IPAM可信服务纳管的成员账号超过Quota限制。', + ], + [ + 'code' => 'QuotaExceeded.ResourceSharePerIpamPool', + 'message' => 'The IPAM pool exceeds the limit for sharing.', + 'http_code' => 400, + 'description' => '单个地址池已超出可共享的上限。', + ], + [ + 'code' => 'QuotaExceeded.ResourceSharePerIpamResourceDiscovery', + 'message' => 'The IPAM resource discovery exceeds the limit for sharing.', + 'http_code' => 400, + 'description' => '单个资源发现已超出可共享的上限。', + ], + [ + 'code' => 'QuotaExceeded.SharedIpamPoolPerUser', + 'message' => 'The number of shared IPAM pools owned by a user exceeds the limit.', + 'http_code' => 400, + 'description' => '单个用户拥有的共享IPAM地址池数量超过限额。', + ], + [ + 'code' => 'QuotaExceeded.SharedIpamResourceDiscoveryPerUser', + 'message' => 'The number of shared IPAM resource discoveries owned by a user exceeds the limit.', + 'http_code' => 400, + 'description' => '单个用户拥有的共享IPAM资源发现的数量超过限额。', + ], + [ + 'code' => 'ResourceNotEnough.IpamPoolCidr', + 'message' => 'The specified resource of IPAM pool CIDR is not enough.', + 'http_code' => 400, + 'description' => '指定的IPAM地址池CIDR资源不足。', + ], + [ + 'code' => 'ResourceNotFound.Ipam', + 'message' => 'The specified resource of ipam is not found.', + 'http_code' => 400, + 'description' => '输入的IPAM不存在。', + ], + [ + 'code' => 'ResourceNotFound.IpamDiscoveredResource', + 'message' => 'The queried %s is not found among IPAM discovered resources.', + 'http_code' => 400, + 'description' => '所查询的%s在IPAM已发现资源中不存在。', + ], + [ + 'code' => 'ResourceNotFound.IpamPool', + 'message' => 'The dependent IPAM pool is not found.', + 'http_code' => 404, + 'description' => '依赖资源IPAM Pool不存在。', + ], + [ + 'code' => 'ResourceNotFound.IpamPoolAllocation', + 'message' => 'The specified resource of IPAM pool allocation is not found.', + 'http_code' => 400, + 'description' => '输入的IPAM地址池分配关系不存在。', + ], + [ + 'code' => 'ResourceNotFound.IpamPoolCidr', + 'message' => 'The specified resource of IPAM pool CIDR is not found.', + 'http_code' => 400, + 'description' => '输入的IPAM地址池CIDR不存在。', + ], + [ + 'code' => 'ResourceNotFound.IpamResourceDiscovery', + 'message' => 'The dependent instance of IPAM resource discovery is not found.', + 'http_code' => 400, + 'description' => '未找到IPAM资源发现实例。', + ], + [ + 'code' => 'ResourceNotFound.IpamScope', + 'message' => 'The specified resource of IPAM scope is not found.', + 'http_code' => 400, + 'description' => '输入的IPAM作用范围不存在。', + ], + [ + 'code' => 'ResourceNotFound.ResourceDiscoveryAssociation', + 'message' => 'You cannot disassociate from the resource discovery because no association exists.', + 'http_code' => 400, + 'description' => '当前资源发现不存在关联关系，操作失败。', + ], + [ + 'code' => 'ResourceNotFound.SourceIpamPool', + 'message' => 'The dependent source IPAM pool is not found.', + 'http_code' => 400, + 'description' => '依赖资源源IPAM Pool不存在。', + ], + [ + 'code' => 'UnsupportedFeature.AddCidrForIpamPrivateIpv6Pool', + 'message' => 'Adding CIDR for IPAM private IPv6 pool is not supported for this user.', + 'http_code' => 400, + 'description' => '当前用户不支持为IPAM私网IPv6地址池预置地址段。', + ], + [ + 'code' => 'UnsupportedFeature.AddUlaCidrForIpamPublicIpv6Pool', + 'message' => 'Adding ULA CIDR for IPAM public IPv6 pool is not supported.', + 'http_code' => 400, + 'description' => '不允许为IPAM公网IPv6地址池预置ULA地址段。', + ], + [ + 'code' => 'UnsupportedFeature.Ipam', + 'message' => 'IPAM is not supported in this region.', + 'http_code' => 400, + 'description' => '该地域不支持IPAM功能。', + ], + [ + 'code' => 'UnsupportedFeature.IpamIpv6', + 'message' => 'The feature of IPv6 is not supported in this region.', + 'http_code' => 400, + 'description' => '该地域不支持在IPAM中使用IPv6功能。', + ], + [ + 'code' => 'UnsupportedFeature.IpamPublicIpv4Pool', + 'message' => 'The feature of public IPv4 pool is not supported in IPAM.', + 'http_code' => 400, + 'description' => 'IPAM暂不支持创建公网IPv4地址池。', + ], + [ + 'code' => 'UnsupportedFeature.Ipv6Isp', + 'message' => 'The Ipv6Isp feature is not supported.', + 'http_code' => 400, + 'description' => '指定的Ipv6Isp特性不支持。', + ], + [ + 'code' => 'UnsupportedFeature.PublicIpamScopeType', + 'message' => 'The feature of PublicIpamScopeType is not supported.', + 'http_code' => 400, + 'description' => '您指定的IPAM暂不支持创建Public类型的作用范围。', + ], + [ + 'code' => 'UnsupportedRegion.Ipam', + 'message' => 'Ipam is not supported in this region.', + 'http_code' => 400, + 'description' => '该地域不支持IPAM。', + ], + [ + 'code' => 'UnsupportedRegion.Ipv6Isp', + 'message' => 'The current region does not support this feature.', + 'http_code' => 400, + 'description' => '当前Region未支持该特性。', + ], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamResourceDiscoveryAssociations', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DissociateIpamResourceDiscovery', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamPools', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListTagResources', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpam', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UntagResources', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamPoolAllocations', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'GetVpcIpamServiceStatus', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamPoolCidrs', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'AssociateIpamResourceDiscovery', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpamPool', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamResourceDiscovery', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamPool', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpamPoolAllocation', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamResourceCidrs', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpamScope', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'OpenVpcIpamService', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpamResourceDiscovery', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpamPoolAllocation', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'GetIpamPoolNextAvailableCidr', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamPoolCidr', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'AddIpamPoolCidr', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpam', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpams', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamPoolAllocation', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpamScope', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'GetIpamPoolAllocation', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamResourceDiscoveries', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'DeleteIpamScope', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpam', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamDiscoveredResource', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'TagResources', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ListIpamScopes', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'CreateIpamResourceDiscovery', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'ChangeResourceGroup', + ], + [ + 'threshold' => '300', + 'countWindow' => 60, + 'regionId' => '*', + 'api' => 'UpdateIpamPool', + ], + ], + ], + 'ram' => [ + 'productCode' => 'VpcIpam', + 'productName' => '专有网络VPC', + 'ramCodes' => [ + 'vpc', + ], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [], + 'resourceTypes' => [], + ], +]; |