'1.0',
'info' => ['style' => 'RPC', 'product' => 'pvtz', 'version' => '2018-01-01'],
'directories' => [
[
'children' => ['DescribeUserServiceStatus', 'SetProxyPattern', 'DescribeChangeLogs', 'DescribeRegions', 'MoveResourceGroup'],
'type' => 'directory',
'title' => '公共',
'id' => 46644,
],
[
'children' => ['AddZone', 'DeleteZone', 'UpdateZoneRemark', 'ChangeZoneDnsGroup', 'BindZoneVpc', 'CheckZoneName', 'DescribeZoneInfo', 'DescribeZones', 'DescribeZoneVpcTree'],
'type' => 'directory',
'title' => 'Zone',
'id' => 46650,
],
[
'children' => ['DescribeTags', 'ListTagResources', 'TagResources', 'UntagResources'],
'type' => 'directory',
'title' => '标签',
'id' => 46660,
],
[
'children' => ['DescribeRequestGraph', 'DescribeStatisticSummary'],
'type' => 'directory',
'title' => '数据',
'id' => 46665,
],
[
'children' => ['AddZoneRecord', 'DeleteZoneRecord', 'SetZoneRecordStatus', 'UpdateRecordRemark', 'UpdateZoneRecord', 'DescribeZoneRecord', 'DescribeZoneRecords'],
'type' => 'directory',
'title' => '解析记录',
'id' => 46668,
],
[
'children' => ['AddResolverEndpoint', 'AddResolverRule', 'BindResolverRuleVpc', 'DeleteResolverEndpoint', 'DeleteResolverRule', 'DescribeResolverEndpoint', 'DescribeResolverEndpoints', 'DescribeResolverRule', 'DescribeResolverRules', 'UpdateResolverEndpoint', 'UpdateResolverRule', 'DescribeResolverAvailableZones'],
'type' => 'directory',
'title' => '转发管理',
'id' => 46680,
],
[
'children' => ['AddCustomLine', 'DeleteCustomLine', 'UpdateCustomLine', 'DescribeCustomLines', 'SearchCustomLines', 'DescribeCustomLineInfo'],
'type' => 'directory',
'title' => '自定义线路 ',
'id' => 46696,
],
[
'children' => ['AddUserVpcAuthorization', 'DescribeUserVpcAuthorizations', 'DeleteUserVpcAuthorization'],
'type' => 'directory',
'title' => '跨账号授权',
'id' => 46676,
],
[
'children' => ['UpdateSyncEcsHostTask', 'DescribeSyncEcsHostTask'],
'type' => 'directory',
'title' => '主机名同步',
'id' => 46693,
],
[
'children' => ['DescribeIntranetUserCanAnalysisVpcs', 'DescribePvtzStatisticsGlobalOverview', 'DescribePvtzStatisticsHistory', 'DescribePvtzStatisticsSummary', 'DescribePvtzStatisticsZoneOverview'],
'title' => '其他',
'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddCustomLine' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '语言。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'en'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '自定义线路名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Custom Route-test'],
],
[
'name' => 'ShareScope',
'in' => 'query',
'schema' => ['description' => '暂不对用户开放,无需传值', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'GLOBAL', 'default' => 'GLOBAL'],
],
[
'name' => 'DnsCategory',
'in' => 'query',
'schema' => ['description' => '暂不对用户开放,无需传值', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'INTRANET', 'default' => 'INTRANET'],
],
[
'name' => 'Ipv4s',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'ipv4地址段列表',
'type' => 'array',
'items' => ['description' => 'ipv4地址段', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.1.1.1'],
'required' => true,
'docRequired' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求Id', 'type' => 'string', 'example' => 'AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60'],
'LineId' => ['description' => '自定义线路唯一ID。', 'type' => 'string', 'example' => '1065001'],
'Name' => ['description' => '自定义线路名称', 'type' => 'string', 'example' => 'Custom Route-test'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CustomLine.IpOverlap', 'errorMessage' => 'customLine ip is overlap.%s', 'description' => '自定义线路ip段重叠'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\",\\n \\"LineId\\": \\"1065001\\",\\n \\"Name\\": \\"Custom Route-test\\"\\n}","type":"json"}]',
'title' => '添加自定义线路',
'summary' => '创建自定义线路。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddCustomLine'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:update',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'AddResolverEndpoint' => [
'summary' => '调用AddResolverEndpoint新增终端节点。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '15390',
'abilityTreeNodes' => ['FEATUREpvtz74JCUU'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '终端节点名称,最长20个字符,超过限制会报错。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'endpoint-test-name'],
],
[
'name' => 'VpcRegionId',
'in' => 'query',
'schema' => ['description' => '出站VPC所在的地域ID(regionID)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => '出站专有网络ID(VPC ID),解析器所有出站的DNS查询流量都将经由此VPC进行流量转发。'."\n"
."\n"
.'>为了避免误操作造成线上流量中断,创建出站终端节点之后,无法更改此值。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'vpc-0jl96awrjt75ezglc****'],
],
[
'name' => 'SecurityGroupId',
'in' => 'query',
'schema' => ['description' => '安全组ID,安全组里面的规则将应用于出站VPC。'."\n"
."\n"
.'>为了避免误操作造成线上流量中断,创建出站终端节点之后,无法更改此值。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sg-0jld3m9yq7l2cw12****'],
],
[
'name' => 'IpConfig',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '出站流量源IP地址列表(至少添加2个,最多可添加6个)。'."\n"
."\n"
.'>为了保证高可用,出站终端节点要求至少添加2个出站源IP地址,而且建议这2个IP地址分配在不同的可用区,出站终端节点允许添加的出站源IP地址最多为6个',
'type' => 'array',
'items' => [
'description' => '出站流量源IP地址信息',
'type' => 'object',
'properties' => [
'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-0jlgeyq4oazkh5xue****'],
'CidrBlock' => ['description' => '子网掩码,交换机的IPv4网段。', 'type' => 'string', 'required' => true, 'example' => '172.16.XX.XX/24'],
'AzId' => ['description' => '交换机的可用区ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-a'],
'Ip' => ['description' => '子网掩码参数范围内的IP地址(留空则系统自动分配)。', 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX'],
],
'required' => false,
],
'required' => true,
'maxItems' => 12,
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码'."\n"
."\n", 'type' => 'string', 'example' => '32436208-E1AF-4DAB-B3B8-24F5F25B0950'],
'EndpointId' => ['description' => '终端节点ID', 'type' => 'string', 'example' => 'hr****'],
],
],
],
],
'title' => '新增终端节点',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddResolverEndpoint'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pvtz:AddResolverEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"32436208-E1AF-4DAB-B3B8-24F5F25B0950\\",\\n \\"EndpointId\\": \\"hr****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 32436208-E1AF-4DAB-B3B8-24F5F25B0950\\n hra0**\\n","errorExample":""}]',
],
'AddResolverRule' => [
'summary' => '调用AddResolverRule新增转发规则。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtzKODT3B'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '转发规则名称,根据业务需要及业务含义进行规则命名。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '转发规则类型:OUTBOUND(目前仅支持选择转发至外部IP)。'."\n"
.'>创建转发规则之后,无法更改此值。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'OUTBOUND'],
],
[
'name' => 'ZoneName',
'in' => 'query',
'schema' => ['description' => '需要转发解析请求的域名(Zone)。'."\n"
."\n"
.'>创建转发规则之后,无法更改此值。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'example.com'],
],
[
'name' => 'EndpointId',
'in' => 'query',
'schema' => ['description' => '出站终端节点ID。使用该出站终端节点将DNS查询流量转发到目标IP地址列表中指定的IP地址。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hr****'],
],
[
'name' => 'ForwardIp',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '外部DNS系统IP地址和端口。DNS查询流量被转发的目标服务器的IP地址和端口,最多创建**6**个,支持私网IP地址和公网IP地址。'."\n"
.'>若您填写的外部DNS服务器为公网IP,且您出站终端节点VPC内ECS无公网IP,请开通NAT网关并配置创建和管理VPC NAT网关的SNAT条目。',
'type' => 'array',
'items' => [
'description' => '转发目标信息。',
'type' => 'object',
'properties' => [
'Ip' => ['description' => '转发目标IP地址。'."\n"
.'>以下地址段内的IP地址为系统预留地址,不允许被配置为外部DNS系统的IP地址:100.100.2.136~100.100.2.138,100.100.2.116~100.100.2.118。', 'type' => 'string', 'required' => true, 'example' => '172.16.XX.XX'],
'Port' => ['description' => '转发目标IP地址端口号。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8080'],
],
'required' => false,
],
'required' => true,
'maxItems' => 12,
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'Vpcs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VpcUserId' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
'VpcType' => ['type' => 'string', 'required' => false, 'description' => ''],
'RegionId' => ['type' => 'string', 'required' => false, 'description' => ''],
'VpcId' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'description' => '',
],
],
[
'name' => 'EdgeDnsClusters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClusterId' => ['type' => 'string', 'required' => false, 'description' => ''],
],
'required' => false,
'description' => '',
],
'required' => false,
'maxItems' => 100,
'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '725B8BED-901F-480C-BBAC-FA59A18580C1'],
'RuleId' => ['description' => '转发规则ID。', 'type' => 'string', 'example' => 'hr****'],
],
'description' => '',
],
],
],
'title' => '新增转发规则',
'description' => '#### **注意事项**'."\n"
.'如果出站VPC和入站VPC是同一个VPC,则出站终端节点关联的转发规则中的外部DNS系统IP地址与入站终端节点服务IP地址不能相同。如果这样做,会导致请求回环造成解析失败。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddResolverRule'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pvtz:AddResolverRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/{#EndpointId}'],
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz:*:{#accountId}:rule/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"725B8BED-901F-480C-BBAC-FA59A18580C1\\",\\n \\"RuleId\\": \\"hr****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 725B8BED-901F-480C-BBAC-FA59A18580C1\\n hra0**\\n","errorExample":""}]',
],
'AddUserVpcAuthorization' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'AuthorizedUserId',
'in' => 'query',
'schema' => ['description' => '授权资源的所属用户主账号ID。'."\n"
.'>跨账号设置生效范围,只支持主账号, 不支持RAM子账号使用。只支持站内账号之间关联,例如中国站账号之间,或者是国际站账号之间。不支持跨站关联,比如中国站账号和国际站账号之间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '141339776561****'],
],
[
'name' => 'AuthCode',
'in' => 'query',
'schema' => ['description' => '验证码。'."\n"
."\n"
.'> - “授权渠道(AuthChannel)”为空或为“验证码授权(AUTH_CODE)”传指定验证码。 '."\n"
.'> - 其他情况传随机6位数即可。例123456。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '123456'],
],
[
'name' => 'AuthType',
'in' => 'query',
'schema' => ['description' => '授权类型。取值:'."\n"
."\n"
.'- NORMAL:普通授权。'."\n"
.'- CLOUD_PRODUCT:云产品授权。', 'type' => 'string', 'required' => false, 'example' => 'NORMAL'],
],
[
'name' => 'AuthChannel',
'in' => 'query',
'schema' => ['description' => '授权渠道。取值:'."\n"
."\n"
.'- AUTH_CODE:验证码授权。'."\n"
.'- RESOURCE_DIRECTORY: 资源目录授权。'."\n"
."\n"
.'默认:AUTH_CODE。', 'type' => 'string', 'required' => false, 'example' => 'AUTH_CODE'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '46973D4C-E3E4-4ABA-9190-9A9DE406C7E'],
],
],
],
],
'title' => '新增跨账号VPC授权',
'summary' => '添加跨账号VPC授权。',
'description' => '#### **使用限制**'."\n"
.'- 跨账号设置生效范围,只支持主账号, 不支持RAM子账号使用。只支持站内账号之间关联,例如中国站账号之间,或者是国际站账号之间。不支持跨站关联,比如中国站账号和国际站账号之间。'."\n"
.'- 针对使用验证码授权的场景,目前没有提供发送验证码的API。'."\n"
.'#### **注意事项**'."\n"
.'当跨账号设置生效范围时,计费统计将以内置权威域名日常管理所在的账号做结算。',
'changeSet' => [
['createdAt' => '2021-06-28T03:53:25.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserVpcAuthorization'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pvtz:AddUserVpcAuthorization',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\"\\n}","type":"json"}]',
],
'AddZone' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'* **zh**:中文。'."\n"
."\n"
.'* **en**:英文。'."\n"
."\n"
.'默认:**en**', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ZoneName',
'in' => 'query',
'schema' => ['description' => '需要新增的zone名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'example.com'],
],
[
'name' => 'ProxyPattern',
'in' => 'query',
'schema' => ['description' => '是否开启子域名递归代理。取值:'."\n"
.'- **ZONE**: 关闭(当解析本域名下不存在的子域名时,直接返回NXDOMAIN,表示子域名不存在)'."\n"
.'- **RECORD**: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)'."\n"
."\n"
.'默认:**ZONE**', 'type' => 'string', 'required' => false, 'example' => 'ZONE'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmykd63gt****'],
],
[
'name' => 'ZoneType',
'in' => 'query',
'schema' => ['description' => '暂不对用户开放,无需传值。', 'type' => 'string', 'required' => false, 'example' => 'CLOUD_PRODUCT_ZONE'],
],
[
'name' => 'ZoneTag',
'in' => 'query',
'schema' => ['description' => '暂不对用户开放,无需传值。', 'type' => 'string', 'required' => false, 'example' => 'BLINK'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持ASCII字符,且不能超过64个字符。', 'type' => 'string', 'required' => false, 'example' => '21079fa016944979537637959d09bc'],
],
[
'name' => 'DnsGroup',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '内置权威位置区。取值:'."\n"
."\n"
.'- **NORMAL_ZONE**:普通区(解析应答结果会被缓存,缓存不命中的情况下才回源到内置权威普通区,解析变更生效受TTL时间影响;无法使用自定义线路解析、权重解析功能。)'."\n"
.'- **FAST_ZONE**:快速区(推荐:直接应答解析请求、解析时延最低,记录变更实时生效;支持自定义线路解析、权重解析。)'."\n"
."\n"
.'默认:**NORMAL_ZONE**'."\n"
."\n"
.'>内置权威加速区在缓存模块前,解析结果不进入缓存,因此将产生更多解析量请求费用。 '."\n"
."\n"
.'>2025年4月30日(UTC+8)起,新开通云解析PrivateZone的用户在添加Zone时,默认将设置为加速区Zone。',
'type' => 'string',
'required' => false,
'example' => 'FAST_ZONE',
'enum' => ['NORMAL_ZONE', 'FAST_ZONE'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ZoneName' => ['description' => 'zone名称。', 'type' => 'string', 'example' => 'example.com'],
'ZoneId' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'example' => '6fc186295683a131f63bb8b0cddc****'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '54F10A2A-C3CF-59D4-810F-F18DDD93FE20'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'title' => '添加zone',
'summary' => '调用AddZone创建内置权威域名,内置权威域名可以添加在普通区或加速区。',
'description' => '2025年4月30日(UTC+8)起,新开通云解析PrivateZone的用户在添加Zone时,默认将设置为加速区Zone。 2025年10月30日(UTC+8)2026年4月30日(UTC+8)起,所有用户的普通区内置权威Zone将自动切换至加速区。切换后解析请求量可能增加,导致使用成本上升。建议为[ECS开启NSCD](~~2592999~~),以减少无本地缓存引发的解析请求增长。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-02-19T11:52:14.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddZone'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pvtz:AddZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ZoneName\\": \\"example.com\\",\\n \\"ZoneId\\": \\"6fc186295683a131f63bb8b0cddc****\\",\\n \\"RequestId\\": \\"54F10A2A-C3CF-59D4-810F-F18DDD93FE20\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n example.com\\n AgIDE1MQ_151\\n 46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\n true\\n","errorExample":""}]',
],
'AddZoneRecord' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'df2d03865266bd9842306db586d3****'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'Rr',
'in' => 'query',
'schema' => ['description' => '主机记录。主机记录就是域名前缀,常见用法有www、@、*(泛解析)、mail(常用于邮箱)。'."\n"
."\n"
.'例如要解析@.exmaple.com,主机记录要填写"@”,而不是空。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'www'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '解析记录类型,目前支持如下:'."\n"
.'- **A**:将域名指向一个IPV4(点分十进制格式的IPv4地址)。'."\n"
.'- **AAAA**:将域名指向一个IPV6(IPv6地址)。'."\n"
.'- **CNAME**:将域名指向另一个域名(域名地址)。'."\n"
.'- **TXT**:文本长度限制255,通常做SPF记录(反垃圾邮件)。'."\n"
.'- **MX**:将域名指向邮件服务器地址(邮件服务器的域名)。'."\n"
.'- **PTR**:将IP地址指向一个域名。'."\n"
.'- **SRV**:记录提供特定的服务的服务器(格式为 优先级 权重 端口 目标地址,每项中间需以空格分隔)。'."\n"
.'> 添加PTR记录前需要先配置反解Zone,具体操作请参考[反向解析及PTR记录](~~2592976~~)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'A'],
],
[
'name' => 'Line',
'in' => 'query',
'schema' => ['description' => '解析请求来源。取值:'."\n"
."\n"
.'- default:默认解析线路(相当于全局线路,建议您配置默认线路用于兜底,保障没有智能线路命中的情况下可以返回解析记录)。'."\n"
.'- 阿里云线路(指解析请求来自阿里云,包括公共云、金融云、政务云)。'."\n"
.'- 自定义线路(可以定制内网域名解析针对来源于某个特殊IP段的DNS查询请求返回特定的IP地址)'."\n"
."\n"
.'>- 内置权威加速区域名才支持添加的解析请求来源线路。'."\n"
.'>- 选择默认解析,输入“default”即可,阿里云线路和自定义线路需填写指定线路编码。'."\n"
.'例:aliyun_r_cn-beijing-a', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'default'],
],
[
'name' => 'Weight',
'in' => 'query',
'schema' => ['description' => '权重值(1-100 内的整数,包括 1 和 100,默认为1),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => ['description' => '本地缓存时间。目前取值仅支持5、30、60、3600(1小时)、43200(12小时)、86400(一天),单位秒(s),默认60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '86400', 'minimum' => '5', 'example' => '60', 'default' => '60'],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => ['description' => 'MX记录的优先级。取值越小,优先级越高,取值范围:**\\[1,99\\]**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99', 'minimum' => '1', 'example' => '5'],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['description' => '记录值。根据不同解析记录类型,填写相应的记录值。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '114.55.XX.XX'."\n"],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => '备注。', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6447728c8578e66aacf062d2df4446dc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '0B7AD377-7E86-44A8-B9A8-53E8666E72FE'],
'RecordId' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '429570****'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'title' => '添加解析记录',
'summary' => '调用AddZoneRecord添加内置权威解析记录。在解析生效范围内,该域名的内网解析记录会覆盖其公网解析记录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-04-12T02:00:26.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddZoneRecord'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'pvtz:AddZoneRecord',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0B7AD377-7E86-44A8-B9A8-53E8666E72FE\\",\\n \\"RecordId\\": 0,\\n \\"Success\\": true\\n}","errorExample":"{\\n \\"Message\\": \\"The request processing has failed due to some unknown error, exception or failure\\", \\n \\"RequestId\\": \\"E246E023-F2EB-4034-83F7-B13FCF31459C\\", \\n \\"Code\\": \\"InternalError\\"\\n}"},{"type":"xml","example":"\\n 5809\\n D4AD014E-46F6-4311-815B-AAB3ACE06F9C\\n","errorExample":"\\n F0B47FE6-C774-4833-9028-B073588A8FAA\\n InternalError\\n The request processing has failed due to some unknown error, exception or failure\\n"}]',
],
'BindResolverRuleVpc' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '转发规则ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hr****'],
],
[
'name' => 'Vpc',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '关联VPC列表。',
'type' => 'array',
'items' => [
'description' => 'vpc信息。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => '专有网络ID(VPC ID)。', 'type' => 'string', 'required' => false, 'example' => 'vpc-f8zvrvr1payllgz38****'],
'RegionId' => ['description' => '出站VPC所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'VpcType' => ['description' => 'VPC类型。取值:'."\n"
."\n"
.'- STANDARD:标准VPC。'."\n"
."\n"
.'- EDS:无影工作区VPC。', 'type' => 'string', 'required' => false, 'example' => 'STANDARD'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '12FE6E98-3885-423E-B18B-88CC17052A31'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ZoneVpc.Zone.Repeated', 'errorMessage' => 'Vpc is bind to same zone name.', 'description' => ''],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"12FE6E98-3885-423E-B18B-88CC17052A31\\"\\n}","errorExample":""},{"type":"xml","example":"12FE6E98-3885-423E-B18B-88CC17052A31","errorExample":""}]',
'title' => '转发规则关联VPC',
'summary' => '调用BindResolverRuleVpc设置转发规则关联VPC。',
'description' => '>本接口采用全量覆盖机制,调用时会清除所有未包含在本次请求中的原有 VPC 绑定关系。如需新增 VPC,请务必将存量 VPC ID 一并传入。>',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-10-17T09:58:33.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2024-10-13T10:53:05.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-01-06T04:15:31.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindResolverRuleVpc'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:BindResolverRuleVpc',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz::{#accountId}:rule/{#RuleId}'],
],
],
],
],
],
'BindZoneVpc' => [
'summary' => '绑定或者解绑zone与VPC列表两者之间的关系,设置域名(zone)生效范围。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtz6J3Z3C'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '34d4031b63c527358b710a61346a****'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
[
'name' => 'Vpcs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'vpc列表信息。'."\n"
.'>若Vpcs为空,则解绑所有Vpc。',
'type' => 'array',
'items' => [
'description' => '关联Vpc信息。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'Vpc ID。当Zone已经绑定Vpc,此时不传入此参数,表示将Zone和Vpc解绑。', 'type' => 'string', 'required' => false, 'example' => 'vpc-f8zvrvr1payllgz38****'],
'RegionId' => ['description' => 'Vpc所属地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
'VpcType' => ['description' => 'Vpc类型。取值:'."\n"
."\n"
.'- **STANDARD**:标准Vpc。'."\n"
."\n"
.'- **EDS**:无影工作区Vpc。', 'type' => 'string', 'required' => false, 'example' => 'STANDARD'],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。', 'type' => 'string', 'required' => false, 'example' => '6447728c8578e66aacf062d2df4446dc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '46973D4C-E3E4-4ABA-9190-9A9DE406C7E'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ZoneVpc.Zone.Repeated', 'errorMessage' => 'Vpc is bind to same zone name.', 'description' => ''],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\"\\n}","type":"json"}]',
'title' => 'zone关联VPC',
'description' => '##### 注意事项:'."\n"
.'域名生效范围建议完成所有解析记录配置后再设置,因为创建域名时如果设置了域名生效范围,这意味着在域名创建成功后、未添加解析记录前这段时间,在生效范围内网络对该域名的解析都会失败(开启了子域名递归解析代理的情况除外)。'."\n"
.'>本接口采用全量覆盖机制,调用时会清除所有未包含在本次请求中的原有 VPC 绑定关系。如需新增 VPC,请务必将存量 VPC ID 一并传入。>',
'changeSet' => [
['createdAt' => '2024-10-17T09:58:33.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2023-01-06T04:15:31.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindZoneVpc'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pvtz:BindZoneVpc',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
],
'ChangeZoneDnsGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone的全局ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e0cff188756b1d4579b25e54b66cb830'],
],
[
'name' => 'DnsGroup',
'in' => 'query',
'schema' => ['description' => '内置权威位置区'."\n"
."\n"
.'- 普通区:NORMAL_ZONE'."\n"
.'- 快速区:FAST_ZONE'."\n"
.'> 2025年4月30日(UTC+8)起,新开通云解析PrivateZone的用户在创建Zone时,默认将设置为加速区Zone。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'NORMAL_ZONE'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多详情,请参见如何保证幂等性。', 'type' => 'string', 'required' => false, 'example' => '85456erer657cfgfg3437'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'Zone的全局ID。', 'type' => 'string', 'example' => 'e0cff188756b1d4579b25e54b66cb830'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB'],
],
],
],
],
'title' => '修改ZONE的位置区',
'summary' => '修改ZONE的位置区。',
'description' => '2025年4月30日(UTC+8)起,新开通云解析PrivateZone的用户在添加Zone时,默认将设置为加速区Zone。 2025年10月30日(UTC+8)2026年4月30日(UTC+8)起,所有用户的普通区内置权威Zone将自动切换至加速区。切换后解析请求量可能增加,导致使用成本上升。建议为[ECS开启NSCD](~~2592999~~),以减少无本地缓存引发的解析请求增长。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeZoneDnsGroup'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:ChangeZoneDnsGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ZoneId\\": \\"e0cff188756b1d4579b25e54b66cb830\\",\\n \\"RequestId\\": \\"C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB\\"\\n}","type":"json"}]',
],
'CheckZoneName' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ZoneName',
'in' => 'query',
'schema' => ['description' => 'zone的名称。此参数为必传参数。', 'type' => 'string', 'required' => false, 'example' => 'example.com'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'CA29B88F-A571-4123-80D5-768AC2F7F806'],
'Check' => ['description' => '检查结果。描述:'."\n"
."\n"
.'- **true**:可添加'."\n"
.'- **false**:不可添加', 'type' => 'boolean', 'example' => 'true'],
'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'title' => '根据规则校验zone是否可添加',
'summary' => '调用CheckZoneName根据规则校验zone名称是否可添加。',
'changeSet' => [
['createdAt' => '2024-01-31T12:33:44.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckZoneName'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:CheckZoneName',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CA29B88F-A571-4123-80D5-768AC2F7F806\\",\\n \\"Check\\": true,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n CA29B88F-A571-4123-80D5-768AC2F7F806\\n true\\n true\\n","errorExample":""}]',
],
'DeleteCustomLine' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '语言。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'en'],
],
[
'name' => 'LineId',
'in' => 'query',
'schema' => ['description' => '自定义线路唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1045001'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求 ID', 'type' => 'string', 'example' => 'A73F3BD0-B1A8-42A9-A9B6-689BBABC4891'],
'LineId' => ['description' => '自定义线路唯一ID。', 'type' => 'string', 'example' => '520002'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CustomLine.InUsed', 'errorMessage' => 'customLine is in used can not delete.%s', 'description' => '自定义线路被引用无法删除'],
],
],
'title' => '删除自定义线路',
'summary' => '删除自定义线路。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomLine'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:update',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'customLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/{#lineId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A73F3BD0-B1A8-42A9-A9B6-689BBABC4891\\",\\n \\"LineId\\": \\"520002\\"\\n}","type":"json"}]',
],
'DeleteResolverEndpoint' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'EndpointId',
'in' => 'query',
'schema' => ['description' => '终端节点ID,终端节点的唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hra0**'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '35134B4A-CEC0-43C8-AAD4-BA54AE3268B5'],
],
],
],
],
'title' => '删除终端节点',
'summary' => '调用DeleteResolverEndpoint根据终端节点ID删除终端节点。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResolverEndpoint'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:DeleteResolverEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/{#EndpointId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"35134B4A-CEC0-43C8-AAD4-BA54AE3268B5\\"\\n}","errorExample":""},{"type":"xml","example":"35134B4A-CEC0-43C8-AAD4-BA54AE3268B5","errorExample":""}]',
],
'DeleteResolverRule' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '转发规则ID'."\n"
."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hr****'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '语言', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '0C9959BE-3A6A-4803-8DCE-973B42ACD599'],
],
],
],
],
'title' => '删除转发规则',
'summary' => '调用DeleteResolverRule根据转发规则ID删除转发规则。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResolverRule'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:DeleteResolverRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz:*:{#accountId}:rule/{#RuleId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C9959BE-3A6A-4803-8DCE-973B42ACD599\\"\\n}","errorExample":""},{"type":"xml","example":"0C9959BE-3A6A-4803-8DCE-973B42ACD599","errorExample":""}]',
],
'DeleteUserVpcAuthorization' => [
'summary' => '调用DeleteUserVpcAuthorization删除跨账号授权,可以根据账号ID和授权类型删除。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtz3KGNVF'],
],
'parameters' => [
[
'name' => 'AuthorizedUserId',
'in' => 'query',
'schema' => ['description' => '授权资源的所属用户主账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '141339776561****'],
],
[
'name' => 'AuthType',
'in' => 'query',
'schema' => ['description' => '授权类型。取值:'."\n"
."\n"
.'- NORMAL:普通授权。'."\n"
.'- CLOUD_PRODUCT:云产品授权。'."\n"
."\n"
.'默认:NORMAL', 'type' => 'string', 'required' => false, 'example' => 'NORMAL'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '46973D4C-E3E4-4ABA-9190-9A9DE406C7E'],
],
],
],
],
'title' => '删除跨账号授权',
'changeSet' => [
['createdAt' => '2021-09-22T06:38:48.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserVpcAuthorization'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pvtz:DeleteUserVpcAuthorization',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\"\\n}","type":"json"}]',
],
'DeleteZone' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。'."\n"
."\n"
.'> 对于已配置域名生效范围的内置权威域名,必须先将其与域名生效范围解除关联,然后才能删除。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0e41496f12da01311d314f17b801****'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持ASCII字符,且不能超过64个字符。', 'type' => 'string', 'required' => false, 'example' => '21079fa016944979537637959d09bc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'example' => '0e41496f12da01311d314f17b801****'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'E246E023-F2EB-4034-83F7-B13FCF31459C'],
],
],
],
],
'title' => '删除zone',
'summary' => '调用DeleteZone删除一个空闲的内置权威域名(Zone)。',
'description' => '#### 注意事项'."\n"
.'已配置域名生效范围的内置权威域名,必须先将其与域名生效范围解除关联,然后才能删除。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteZone'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pvtz:DeleteZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ZoneId\\": \\"0e41496f12da01311d314f17b801****\\",\\n \\"RequestId\\": \\"E246E023-F2EB-4034-83F7-B13FCF31459C\\"\\n}","errorExample":"{\\n \\"Message\\": \\"The request processing has failed due to some unknown error, exception or failure\\", \\n \\"RequestId\\": \\"E246E023-F2EB-4034-83F7-B13FCF31459C\\", \\n \\"Code\\": \\"InternalError\\"\\n}"},{"type":"xml","example":"\\n B5174E6E-0AA6-4524-BCE4-603DED055319\\n AgIDE1MA_151\\n","errorExample":"\\n F0B47FE6-C774-4833-9028-B073588A8FAA\\n InternalError\\n The request processing has failed due to some unknown error, exception or failure\\n"}]',
],
'DeleteZoneRecord' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '306279****'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6447728c8578e66aacf062d2df4446dc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '0B7AD377-7E86-44A8-B9A8-53E8666E72FE'],
'RecordId' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '306279****'],
],
],
],
],
'title' => '删除解析记录',
'summary' => '调用DeleteZoneRecord根据解析记录ID删除解析记录。',
'description' => '#### **注意事项**'."\n"
.'删除记录不可恢复,请谨慎操作。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteZoneRecord'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'pvtz:DeleteZoneRecord',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B7AD377-7E86-44A8-B9A8-53E8666E72FE\\",\\n \\"RecordId\\": 0\\n}","type":"json"}]',
],
'DescribeChangeLogs' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '15405',
'abilityTreeNodes' => ['FEATUREpvtzBZMYLJ'],
],
'parameters' => [
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => '关键字(行为、内容)。支持模糊查询,不区分大小写。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID。 是否为空:'."\n"
.'- 若ZondId非空,则获取当前Zone的解析记录变更日志。
'."\n"
.'- 若ZoneId为空,则获取当前账户下所有Zone操作及Zone解析变更日志。', 'type' => 'string', 'required' => false, 'example' => 'df2d03865266bd9842306db586d3****'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时设置查询的页码,起始值为 1,默认为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页数据量,最大值 100,默认为 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '100', 'default' => '20'],
],
[
'name' => 'StartTimestamp',
'in' => 'query',
'schema' => ['description' => '开始时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1516779348000'],
],
[
'name' => 'EndTimestamp',
'in' => 'query',
'schema' => ['description' => '结束时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2516779348000'],
],
[
'name' => 'EntityType',
'in' => 'query',
'schema' => ['description' => '获取的日志类型。取值:'."\n"
."\n"
.'- **PV_ZONE**:内置权威zone的操作日志。'."\n"
.'- **PV_RECORD**:解析记录的操作日志。'."\n"
.'- **RESOLVER_RULE**:转发规则的操作日志。'."\n"
.'- **CUSTOM_LINE**:自定义线路的操作日志。'."\n"
.'- **RESOLVER_ENDPOINT**:出站终端节点的操作日志。'."\n"
.'- **INBOUND_ENDPOINT**:入站终端节点的操作日志。'."\n"
.'- **CACHE_RESERVE_DOMAIN**:缓存保持域名的操作日志。'."\n"
."\n\n"
.'> 其它值则忽略,获取所有类型日志。', 'type' => 'string', 'required' => false, 'example' => 'PV_ZONE'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '192.0.XX.XX'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '返回的每页数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'F0FCB52A-D512-41A0-8595-40234EDCFD8B'],
'ChangeLogs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ChangeLog' => [
'description' => '变更日志列表。',
'type' => 'array',
'items' => [
'description' => '变更日志详情。',
'type' => 'object',
'properties' => [
'OperTimestamp' => ['description' => '操作发生的时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1721619906972'],
'EntityId' => ['description' => '域名、自定义解析线路、转发规则、出站终端节点、入站终端节点等的唯一标识码。', 'type' => 'string', 'example' => 'df2d03865266bd9842306db586d3****'],
'OperObject' => ['description' => '操作对象类型。说明:'."\n"
.'- **PV_ZONE**:内置权威zone。'."\n"
.'- **PV_RECORD**:解析记录。'."\n"
.'- **RESOLVER_RULE**:转发规则。'."\n"
.'- **CUSTOM_LINE**:自定义线路。'."\n"
.'- **RESOLVER_ENDPOINT**:出站终端节点。'."\n"
.'- **INBOUND_ENDPOINT**:入站终端节点。'."\n"
.'- **CACHE_RESERVE_DOMAIN**:缓存保持域名。', 'type' => 'string', 'example' => 'PV_RECORD'],
'OperTime' => ['description' => '操作发生的时间。', 'type' => 'string', 'example' => '2024-07-22T03:45Z'],
'OperIp' => ['description' => '操作本次变更的IP地址(公网IP,如果操作终端设备为私网IP,那此处记录的IP为用户终端NAT之后的公网IP)。', 'type' => 'string', 'example' => '192.0.XX.XX'],
'OperAction' => ['description' => '对操作对象的具体操作行为,例如增加、删除、修改、关联等。', 'type' => 'string', 'example' => 'add'],
'Content' => ['description' => '操作内容。记录本次操作的具体内容。', 'type' => 'string', 'example' => 'Add RR:test.03 Type:A Line:default TTL:300 Value:172.20.XX.XX'],
'EntityName' => ['description' => '操作对象名称。指操作的主体,例如域名、自定义解析线路、缓存保持域名、转发规则、出站终端节点、入站终端节点。', 'type' => 'string', 'example' => 'test.03'],
'Id' => ['description' => '操作记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '90761578646770****'],
'CreatorId' => ['description' => '操作者ID。完成这个操作的实施人ID。', 'type' => 'string', 'example' => '141339776561****'],
'CreatorType' => ['description' => '操作者类型。取值为空或**USER**', 'type' => 'string', 'example' => 'USER'],
'CreatorSubType' => ['description' => '操作者子类型。取值:'."\n"
."\n"
.'- CUSTOMER:主账号'."\n"
.'- SUB:子账号'."\n"
.'- STS:角色扮演'."\n"
.'- OTHER:其他', 'type' => 'string', 'example' => 'CUSTOMER'],
'CreatorUserId' => ['description' => '操作者ID。', 'type' => 'string', 'example' => '141339776561****'],
],
],
],
],
],
'PageNumber' => ['description' => '返回数据的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPages' => ['description' => '全部数据的总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalItems' => ['description' => '日志列表总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
'title' => '获取操作日志',
'summary' => '调用DescribeChangeLogs接口获取内网DNS解析操作日志。操作日志是记录内置权威、缓存管理、转发管理、服务地址以及查询解析记录的操作日志,可以根据行为、内容等关键字进行模糊查询。',
'description' => '#### **使用限制**'."\n"
.'内网DNS操作日志查询时间限制为6个月。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-11-25T12:38:24.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeChangeLogs'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeChangeLogs',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"F0FCB52A-D512-41A0-8595-40234EDCFD8B\\",\\n \\"ChangeLogs\\": {\\n \\"ChangeLog\\": [\\n {\\n \\"OperTimestamp\\": 1721619906972,\\n \\"EntityId\\": \\"df2d03865266bd9842306db586d3****\\",\\n \\"OperObject\\": \\"PV_RECORD\\",\\n \\"OperTime\\": \\"2024-07-22T03:45Z\\",\\n \\"OperIp\\": \\"192.0.XX.XX\\",\\n \\"OperAction\\": \\"add\\",\\n \\"Content\\": \\"Add RR:test.03 Type:A Line:default TTL:300 Value:172.20.XX.XX\\",\\n \\"EntityName\\": \\"test.03\\",\\n \\"Id\\": 0,\\n \\"CreatorId\\": \\"141339776561****\\",\\n \\"CreatorType\\": \\"USER\\",\\n \\"CreatorSubType\\": \\"CUSTOMER\\",\\n \\"CreatorUserId\\": \\"141339776561****\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1\\n}","errorExample":"{\\n \\"Message\\": \\"The request processing has failed due to some unknown error, exception or failure\\", \\n \\"RequestId\\": \\"E246E023-F2EB-4034-83F7-B13FCF31459C\\", \\n \\"Code\\": \\"InternalError\\"\\n}"},{"type":"xml","example":"\\n 1\\n \\n \\n 1516779348000\\n add\\n PV_ZONE\\n 106.11.34.7\\n 6726\\n test-api.com\\n 2018-01-24T07:35Z\\n add test-api.com\\n CAgICA1OA_58\\n \\n \\n 1\\n F0FCB52A-D512-41A0-8595-40234EDCFD8B\\n 224\\n 224\\n","errorExample":"\\n F0B47FE6-C774-4833-9028-B073588A8FAA\\n InternalError\\n The request processing has failed due to some unknown error, exception or failure\\n"}]',
],
'DescribeCustomLineInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'chargeType' => 'free',
'abilityTreeCode' => '190584',
'abilityTreeNodes' => ['FEATUREpvtzNNOVSD'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '语言。', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'LineId',
'in' => 'query',
'schema' => ['description' => '自定义线路唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '11271'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0B7AD377-7E86-44A8-B9A8-53E8666E72FE'],
'LineId' => ['description' => '自定义线路唯一ID。', 'type' => 'string', 'example' => '100003'],
'Name' => ['description' => '自定义线路名称', 'type' => 'string', 'example' => 'Test'],
'Ipv4s' => [
'description' => 'ipv4地址段列表',
'type' => 'array',
'items' => ['description' => 'ipv4地址段', 'type' => 'string', 'example' => '1.1.1.1-2.2.2.2'],
],
'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => '260282302749096109'],
'CreatorType' => ['description' => '创建者角色:'."\n"
.'- USER:用户'."\n"
.'- SYSTEM:系统', 'type' => 'string', 'example' => 'USER'],
'CreatorSubType' => ['description' => '创建者类型。'."\n"
.'- CUSTOM:主账号'."\n"
.'- SUB:子账号'."\n"
.'- STS:角色扮演'."\n"
.'- OTHER:其他角色', 'type' => 'string', 'example' => 'CUSTOM'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2018-01-23T03:15Z'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2018-01-24T06:35Z'],
'CreateTimestamp' => ['description' => ' '."\n"
.'创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1516775741000'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1516775741000'],
'Dnscategory' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B7AD377-7E86-44A8-B9A8-53E8666E72FE\\",\\n \\"LineId\\": \\"100003\\",\\n \\"Name\\": \\"Test\\",\\n \\"Ipv4s\\": [\\n \\"1.1.1.1-2.2.2.2\\"\\n ],\\n \\"Creator\\": \\"260282302749096109\\",\\n \\"CreatorType\\": \\"USER\\",\\n \\"CreatorSubType\\": \\"CUSTOM\\",\\n \\"CreateTime\\": \\"2018-01-23T03:15Z\\",\\n \\"UpdateTime\\": \\"2018-01-24T06:35Z\\",\\n \\"CreateTimestamp\\": 1516775741000,\\n \\"UpdateTimestamp\\": 1516775741000,\\n \\"Dnscategory\\": \\"\\"\\n}","type":"json"}]',
'title' => '查询自定义线路详细信息',
'summary' => '查询自定义线路详细信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomLineInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:read',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'customLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/{#lineId}'],
],
],
],
],
],
'DescribeCustomLines' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'chargeType' => 'free',
'abilityTreeCode' => '190582',
'abilityTreeNodes' => ['FEATUREpvtzNNOVSD'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '语言。', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页码,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页行数,最大值**100**,默认为**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '分页查询时设置的每页行数,最大值**100**,默认为**10**。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60'],
'PageNumber' => ['description' => '当前页数,起始值为**1**,默认为**1**。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPages' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'TotalItems' => ['description' => '总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'CustomLines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CustomLine' => [
'description' => '自定义线路列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LineId' => ['description' => '自定义线路唯一ID。', 'type' => 'string', 'example' => '160002'],
'Name' => ['description' => '自定义线路名称。', 'type' => 'string', 'example' => 'Test route'],
'Ipv4s' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ipv4' => [
'description' => 'ipv4地址段列表。',
'type' => 'array',
'items' => ['description' => 'ipv4地址段。', 'type' => 'string', 'example' => '1.1.1.1'],
],
],
'description' => '',
],
'Creator' => ['description' => '创建者。', 'type' => 'string', 'example' => '21312421'],
'CreatorType' => ['description' => '创建者角色。'."\n"
.'- USER:用户'."\n"
.'- SYSTEM:系统', 'type' => 'string', 'example' => 'USER'],
'CreatorSubType' => ['description' => '创建者类型。'."\n"
.'- CUSTOM:主账号'."\n"
.'- SUB:子账号'."\n"
.'- STS:角色扮演'."\n"
.'- OTHER:其他角色', 'type' => 'string', 'example' => 'SUB'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-03-25T08:07Z'],
'CreateTimestamp' => ['description' => '创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1671174074000'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-08-24T16:08Z'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1681879029000'],
'DnsCategory' => ['type' => 'string'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 5,\\n \\"TotalItems\\": 100,\\n \\"CustomLines\\": {\\n \\"CustomLine\\": [\\n {\\n \\"LineId\\": \\"160002\\",\\n \\"Name\\": \\"Test route\\",\\n \\"Ipv4s\\": {\\n \\"Ipv4\\": [\\n \\"1.1.1.1\\"\\n ]\\n },\\n \\"Creator\\": \\"21312421\\",\\n \\"CreatorType\\": \\"USER\\",\\n \\"CreatorSubType\\": \\"SUB\\",\\n \\"CreateTime\\": \\"2022-03-25T08:07Z\\",\\n \\"CreateTimestamp\\": 1671174074000,\\n \\"UpdateTime\\": \\"2020-08-24T16:08Z\\",\\n \\"UpdateTimestamp\\": 1681879029000,\\n \\"DnsCategory\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询自定义线路列表',
'summary' => '查询自定义线路列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomLines'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:read',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'CustomLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/*'],
],
],
],
],
],
'DescribeIntranetUserCanAnalysisVpcs' => [
'summary' => '获取用户可以分析的VPC列表',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtz3KGNVF'],
],
'parameters' => [
[
'name' => 'NetworkType',
'in' => 'query',
'schema' => ['description' => '查询类型', 'type' => 'string', 'required' => false, 'example' => 'CLOUD'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '返回数据的当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '页面大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'QueryTreeLevel',
'in' => 'query',
'schema' => ['description' => '查询层级,比如某个账户下某个VPC', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'VpcOwner',
'in' => 'query',
'schema' => ['description' => 'VPC所有者', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1204673843521685'],
],
[
'name' => 'VpcType',
'in' => 'query',
'schema' => ['description' => '查询VPC类型级别时返回', 'type' => 'string', 'required' => false, 'example' => 'STANDARD'],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => '查询Region级别时返回', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '对象',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB'],
'CurPage' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'PageSize' => ['description' => '返回的每页数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPage' => ['description' => '查询到的工作空间总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'TotalSize' => ['description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '35'],
'UserCanAnalysisVpcsPopResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'UserCanAnalysisVpcsPopResult' => [
'description' => '应答数据集合',
'type' => 'array',
'items' => [
'description' => '对象',
'type' => 'object',
'properties' => [
'TreeLevel' => ['description' => '查询层级,比如某个账户下某个 VPC', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'NetworkType' => ['description' => '查询网络类型级别时返回', 'type' => 'string', 'example' => 'CLOUD'],
'AuthType' => ['description' => '查询用户级别时时返回', 'type' => 'string', 'example' => 'NORMAL'],
'AuthorizedUserId' => ['description' => '查询用户级别时返回', 'type' => 'integer', 'format' => 'int64', 'example' => '1204673843521685'],
'VpcType' => ['description' => '查询VPC类型级别时返回', 'type' => 'string', 'example' => 'STANDARD'],
'RegionId' => ['description' => '查询Region级别时返回', 'type' => 'string', 'example' => 'cn-beijing'],
'VpcId' => ['description' => '查询Vpc级别时返回', 'type' => 'string', 'example' => 'vpc-bp16tq6uhxuotmh745zvl'],
],
],
],
],
'description' => '',
],
],
],
],
],
'title' => '查看用户可分析的VPC列表',
'description' => '此接口性能不高,不建议使用。请使用 DescribeZones 获取 zone 列表。如果获取绑定的 vpc 详情,则根据 zoneId 来调用接口 DescribeZoneInfo 来获取。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pvtz:DescribeIntranetUserCanAnalysisVpcs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB\\",\\n \\"CurPage\\": 11,\\n \\"PageSize\\": 1,\\n \\"TotalPage\\": 0,\\n \\"TotalSize\\": 35,\\n \\"UserCanAnalysisVpcsPopResults\\": {\\n \\"UserCanAnalysisVpcsPopResult\\": [\\n {\\n \\"TreeLevel\\": 0,\\n \\"NetworkType\\": \\"CLOUD\\",\\n \\"AuthType\\": \\"NORMAL\\",\\n \\"AuthorizedUserId\\": 1204673843521685,\\n \\"VpcType\\": \\"STANDARD\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"VpcId\\": \\"vpc-bp16tq6uhxuotmh745zvl\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribePvtzStatisticsGlobalOverview' => [
'summary' => 'Pvtz解析统计信息全局总览',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtz18XH29'],
],
'parameters' => [
[
'name' => 'ServerRegion',
'in' => 'query',
'schema' => ['description' => '服务区域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OverviewPeriod',
'in' => 'query',
'schema' => ['description' => '统计周期', 'type' => 'string', 'required' => false, 'example' => 'DAY, WEEK, MONTH'],
],
[
'name' => 'NetworkParams',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '网络参数',
'type' => 'array',
'items' => [
'description' => '对象',
'type' => 'object',
'properties' => [
'VpcOwner' => ['description' => 'VPC所有者', 'type' => 'string', 'required' => false, 'example' => '5924158341670144'],
'VpcType' => ['description' => 'VPC类型。'."\n"
."\n"
.'- **STANDARD**:标准VPC。'."\n"
."\n"
.'- **EDS**:无影工作区VPC。', 'type' => 'string', 'required' => false, 'example' => 'STANDARD'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong'],
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1y5y4wk5810n50cx765'],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0B7AD377-7E86-44A8-B9A8-53E8666E72FE'],
'Data' => [
'description' => '统计结果。',
'type' => 'object',
'properties' => [
'TotalResolveCount' => ['description' => '统计所有启用流量分析VPC的总解析数', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'],
'TotalResolveCountTrend' => ['description' => '统计所有启用流量分析VPC的解析量趋势', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'AvgSuccessRatio' => ['description' => '统计所有启用流量分析的VPC的平均解析成功率', 'type' => 'integer', 'format' => 'int64', 'example' => '98'],
'AvgSuccessRatioTrend' => ['description' => '统计所有启用流量分析的VPC的平均解析成功率趋势变化', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'AvgResolveLatency' => ['description' => '统计所有启用流量分析的VPC的平均解析时延。平均解析时延是指:阿里云 DNS 服务器从接收到 DNS 查询请求起,到生成并返回解析应答为止的平均耗时。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'AvgResolveLatencyTrend' => ['description' => '统计所有启用流量分析的VPC的平均解析时延趋势变化。', 'type' => 'integer', 'format' => 'int64', 'example' => '-2'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Private Zone全局解析统计概览',
'description' => '#### **使用限制**'."\n"
.'目前仅支持查询Zone资源的标签信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribePvtzStatisticsGlobalOverview',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B7AD377-7E86-44A8-B9A8-53E8666E72FE\\",\\n \\"Data\\": {\\n \\"TotalResolveCount\\": 100000,\\n \\"TotalResolveCountTrend\\": 5,\\n \\"AvgSuccessRatio\\": 98,\\n \\"AvgSuccessRatioTrend\\": 1,\\n \\"AvgResolveLatency\\": 15,\\n \\"AvgResolveLatencyTrend\\": -2\\n }\\n}","type":"json"}]',
],
'DescribePvtzStatisticsHistory' => [
'summary' => 'Pvtz解析统计信息趋势',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtz18XH29'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'ServerRegion',
'in' => 'query',
'schema' => ['description' => '服务区域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Module',
'in' => 'query',
'schema' => ['description' => '统计模块', 'type' => 'string', 'required' => false, 'example' => 'AUTH'],
],
[
'name' => 'StatisticalType',
'in' => 'query',
'schema' => ['description' => '设置采集统计类型', 'type' => 'string', 'required' => false, 'example' => '- PROTOCOL: DNS request statistics by UDP and TCP protocol (global domain statistics only).'."\n"
.'- FORWARD: Forwarding resolution volume, including successful resolutions, failed resolutions, and total resolutions.'."\n"
.'- RECURSION: Recursive resolution volume, including successful resolutions, failed resolutions, and total resolutions.'."\n"
.'- QTYPE: Distribution of DNS request record types, such as A, AAAA, CNAME, and MX.'."\n"
.'- RCODE: Negative DNS response statistics.'."\n"
.'- SUCCESS_RATIO: Average resolution success rate (resolution success rate = number of valid responses matching the requested record type (QTYPE) / total number of resolutions).'."\n"
.'- LATENCY: Average DNS resolution latency (ms), which is the average time elapsed from when the Alibaba Cloud DNS server receives a DNS query to when it generates and returns a response.'."\n"
.'- REQUEST: DNS request volume statistics, showing QPS query trends.'],
],
[
'name' => 'StartTimestamp',
'in' => 'query',
'schema' => ['description' => '开始时间(时间戳)。', 'type' => 'string', 'required' => false, 'example' => '1516779348000'],
],
[
'name' => 'EndTimestamp',
'in' => 'query',
'schema' => ['description' => '结束时间(时间戳)。', 'type' => 'string', 'required' => false, 'example' => '1571673600000'],
],
[
'name' => 'ZoneName',
'in' => 'query',
'schema' => ['description' => 'zone名称', 'type' => 'string', 'required' => false, 'example' => 'host.local'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '域名名称。', 'type' => 'string', 'required' => false, 'example' => 'example.com'],
],
[
'name' => 'Rcode',
'in' => 'query',
'schema' => ['description' => 'dns响应码', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'NetworkParams',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '网络参数',
'type' => 'array',
'items' => [
'description' => '对象',
'type' => 'object',
'properties' => [
'VpcOwner' => ['description' => 'VPC所有者', 'type' => 'string', 'required' => false, 'example' => '1634808626233933'],
'VpcType' => ['description' => 'vpc类型。描述:'."\n"
."\n"
.'- STANDARD:标准VPC。'."\n"
."\n"
.'- EDS:无影工作区VPC。', 'type' => 'string', 'required' => false, 'example' => 'STANDARD'],
'RegionId' => ['description' => ' '."\n"
.'地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
'VpcId' => ['description' => 'Vpc ID。VPC唯一识别码。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1hneq5pcy2gv87op0uf'],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '46973D4C-E3E4-4ABA-9190-9A9DE406C7E'],
'Data' => [
'description' => '统计结果。',
'type' => 'array',
'items' => [
'description' => '对象',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '统计时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1687190400000'],
'ZoneName' => ['description' => 'zone名称。', 'type' => 'string', 'example' => 'cn-zhangjiakou-share.log.aliyuncs.com'],
'DomainName' => ['description' => '域名名称。', 'type' => 'string', 'example' => 'wget At8P8tza.popscan.xaliyun.com'],
'Protocol' => ['description' => '协议类型', 'type' => 'string', 'example' => 'UDP、TCP'],
'Qtype' => ['description' => '请求记录类型', 'type' => 'string', 'example' => 'A'],
'Count' => ['description' => '任务总数', 'type' => 'integer', 'format' => 'int64', 'example' => '29'],
'Ratio' => ['description' => '成功率或占比', 'type' => 'integer', 'format' => 'int64', 'example' => '95'],
'SuccessCount' => ['description' => '成功总数', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'FailCount' => ['description' => '否定应答数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Private Zone各统计指标历史统计查询',
'description' => '#### **使用限制**'."\n"
.'目前仅支持查询Zone资源的标签信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\",\\n \\"Data\\": [\\n {\\n \\"Timestamp\\": 1687190400000,\\n \\"ZoneName\\": \\"cn-zhangjiakou-share.log.aliyuncs.com\\",\\n \\"DomainName\\": \\"wget At8P8tza.popscan.xaliyun.com\\",\\n \\"Protocol\\": \\"UDP、TCP\\",\\n \\"Qtype\\": \\"A\\",\\n \\"Count\\": 29,\\n \\"Ratio\\": 95,\\n \\"SuccessCount\\": 5,\\n \\"FailCount\\": 100\\n }\\n ]\\n}","type":"json"}]',
],
'DescribePvtzStatisticsSummary' => [
'summary' => 'Pvtz解析统计信息摘要列表',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtzIW8TCT'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'ServerRegion',
'in' => 'query',
'schema' => ['description' => '服务区域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'StartTimestamp',
'in' => 'query',
'schema' => ['description' => '开始时间(时间戳)。', 'type' => 'string', 'required' => false, 'example' => '1571587200000'],
],
[
'name' => 'EndTimestamp',
'in' => 'query',
'schema' => ['description' => '结束时间(时间戳)。', 'type' => 'string', 'required' => false, 'example' => '1571673600000'],
],
[
'name' => 'Module',
'in' => 'query',
'schema' => ['description' => '统计模块', 'type' => 'string', 'required' => false, 'example' => 'AUTH_FAST'],
],
[
'name' => 'StatisticalType',
'in' => 'query',
'schema' => [
'description' => '设置采集统计类型',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '- QTYPE_RATIO: Distribution ratio of DNS request record types.'."\n"
.'- NEGATIVE_RCODE: Negative DNS response type statistics.'."\n"
.'- RCODE_DOMAIN: Top domains by negative response count'."\n"
.'- RCODE_SOURCE_IP: Top source IP addresses requesting a specific domain with negative responses.'."\n"
.'- REQUEST_ZONE: Domain request volume ranking (zone level).'."\n"
.'- REQUEST_DOMAIN: Subdomain request volume ranking (domain name level).'."\n"
.'- VPC_RATIO: Request source distribution ratio.'."\n"
.'- SOURCE_VPC: Hot source network analysis for requests.'."\n"
.'- SOURCE_IP: Request source IP address statistics.'."\n"
.'- LINE_RATIO: Traffic distribution ratio by resolution line.'."\n"
.'- LINE_HIT: Resolution line hit details.',
],
],
[
'name' => 'ZoneName',
'in' => 'query',
'schema' => ['description' => 'zone名称', 'type' => 'string', 'required' => false, 'example' => 'host.local'],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => ['description' => '域名名称。', 'type' => 'string', 'required' => false, 'example' => 'example.com'],
],
[
'name' => 'Rcode',
'in' => 'query',
'schema' => ['description' => 'dns响应码', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => ['description' => '排序方向(ASC, DESC)', 'type' => 'string', 'required' => false, 'example' => 'ASC'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '返回数据的当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '返回的每页数据量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'NetworkParams',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '网络参数',
'type' => 'array',
'items' => [
'description' => '对象',
'type' => 'object',
'properties' => [
'VpcOwner' => ['description' => 'VPC所有者', 'type' => 'string', 'required' => false, 'example' => '1256177436790486'],
'VpcType' => ['description' => 'vpc类型。'."\n"
."\n"
.'- STANDARD:标准VPC。'."\n"
."\n"
.'- EDS:无影工作区VPC。', 'type' => 'string', 'required' => false, 'example' => 'STANDARD'],
'RegionId' => ['description' => ' '."\n"
.'地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1uvv79h1t8unnzdh3nq'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '统计周期', 'type' => 'string', 'required' => false, 'example' => 'day'],
],
[
'name' => 'GrowType',
'in' => 'query',
'schema' => ['description' => '请求量突增突降子域名数报表', 'type' => 'string', 'required' => false, 'example' => 'up'],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => ['description' => '排序字段。按照波动率排序:fluctuation_ratio', 'type' => 'string', 'required' => false, 'example' => 'fluctuation_ratio'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F0FCB52A-D512-41A0-8595-40234EDCFD8B'],
'CurPage' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页查询时设置的每页行数,最大值**100**,默认为**10**。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPage' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'TotalSize' => ['description' => '总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'PageData' => [
'description' => '分页参数',
'type' => 'array',
'items' => [
'description' => '分页参数',
'type' => 'object',
'properties' => [
'ZoneName' => ['description' => 'Zone名称。', 'type' => 'string', 'example' => 'bwcj.biz'],
'DomainName' => ['description' => '域名名称。', 'type' => 'string', 'example' => 'lb-ni1iadds-2c8uyzvgrm5ftsnq.clb.gz-tencentclb.com'],
'Protocol' => ['description' => '协议类型', 'type' => 'string', 'example' => 'UDP'],
'Line' => ['description' => '解析线路。', 'type' => 'string', 'example' => 'default'],
'Qtype' => ['description' => '请求记录类型', 'type' => 'string', 'example' => 'A'],
'SourceRegion' => ['description' => '产品所属的源地域。', 'type' => 'string', 'example' => 'cn-beijing'],
'SourceIsp' => ['description' => '请求源运营商。', 'type' => 'string', 'example' => 'telecom'],
'SourceIp' => ['description' => '请求源地址', 'type' => 'string', 'example' => '110.19.60.72'],
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1uvv79h1t8unnzdh3nq'],
'Rcode' => ['description' => 'DNS响应码', 'type' => 'string', 'example' => '0'],
'Module' => ['description' => '统计模块', 'type' => 'string', 'example' => 'AUTHORITY'],
'Count' => ['description' => '任务总数', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'Ratio' => ['description' => '成功率或占比', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'Latency' => ['description' => '平均解析时延,单位ms', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'ZoneId' => ['description' => 'Zone ID。 是否为空:'."\n"
.'- 若ZondId非空,则获取当前Zone的解析记录变更日志。
'."\n"
.'- 若ZoneId为空,则获取当前账户下所有Zone操作及Zone解析变更日志。', 'type' => 'string', 'example' => '479226c2db1f9bed449b0502c13bcd9d'],
'PreviousCount' => ['description' => '前周期值', 'type' => 'integer', 'format' => 'int64', 'example' => '2227'],
'AggrTimestamp' => ['description' => '当前周期起始时间(分钟的第0秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1776774900000'],
'FluctuationValue' => ['description' => '波动率', 'type' => 'integer', 'format' => 'int32', 'example' => '19'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Private Zone各统计指标详情列表',
'description' => '#### **使用限制**'."\n"
.'目前仅支持查询Zone资源的标签信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F0FCB52A-D512-41A0-8595-40234EDCFD8B\\",\\n \\"CurPage\\": 1,\\n \\"PageSize\\": 1,\\n \\"TotalPage\\": 10,\\n \\"TotalSize\\": 11,\\n \\"PageData\\": [\\n {\\n \\"ZoneName\\": \\"bwcj.biz\\",\\n \\"DomainName\\": \\"lb-ni1iadds-2c8uyzvgrm5ftsnq.clb.gz-tencentclb.com\\",\\n \\"Protocol\\": \\"UDP\\",\\n \\"Line\\": \\"default\\",\\n \\"Qtype\\": \\"A\\",\\n \\"SourceRegion\\": \\"cn-beijing\\",\\n \\"SourceIsp\\": \\"telecom\\",\\n \\"SourceIp\\": \\"110.19.60.72\\",\\n \\"VpcId\\": \\"vpc-bp1uvv79h1t8unnzdh3nq\\",\\n \\"Rcode\\": \\"0\\",\\n \\"Module\\": \\"AUTHORITY\\",\\n \\"Count\\": 4,\\n \\"Ratio\\": 30,\\n \\"Latency\\": 30,\\n \\"ZoneId\\": \\"479226c2db1f9bed449b0502c13bcd9d\\",\\n \\"PreviousCount\\": 2227,\\n \\"AggrTimestamp\\": 1776774900000,\\n \\"FluctuationValue\\": 19\\n }\\n ]\\n}","type":"json"}]',
],
'DescribePvtzStatisticsZoneOverview' => [
'summary' => 'Pvtz解析统计信息Zone维度总览',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtz18XH29'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => ['description' => '支持的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
.'- en-US:英文'."\n"
."\n"
.'默认:en-US'."\n"
.'>优先级高于Lang。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '客户端Token,用于保证请求的幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '234534535432323...'],
],
[
'name' => 'ServerRegion',
'in' => 'query',
'schema' => ['description' => '服务区域', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'OverviewPeriod',
'in' => 'query',
'schema' => ['description' => '统计周期', 'type' => 'string', 'required' => false, 'example' => 'DAY'],
],
[
'name' => 'Module',
'in' => 'query',
'schema' => ['description' => '统计模块', 'type' => 'string', 'required' => false, 'example' => 'AUTHORITY'],
],
[
'name' => 'NetworkParams',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '网络参数',
'type' => 'array',
'items' => [
'description' => '网络参数',
'type' => 'object',
'properties' => [
'VpcOwner' => ['description' => 'VPC所有者', 'type' => 'string', 'required' => false, 'example' => '5209821778041881'],
'VpcType' => ['description' => 'vpc类型。描述:'."\n"
."\n"
.'- STANDARD:标准VPC。'."\n"
."\n"
.'- EDS:无影工作区VPC。', 'type' => 'string', 'required' => false, 'example' => 'STANDARD'],
'RegionId' => ['description' => 'Vpc所属地域 ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hongkong'],
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf68l2l04nqoyg7ie1kaw'],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB'],
'Data' => [
'description' => '统计结果。',
'type' => 'object',
'properties' => [
'SuddenIncreaseDomainCount' => ['description' => 'QPS突增域名数量', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'SuddenDropDomainCount' => ['description' => 'QPS突降域名数量', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'RefusedDomainCount' => ['description' => '否定应答域名数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Private Zone域名解析统计概览',
'description' => '此接口性能不高,不建议使用。请使用 DescribeZones 获取 zone 列表。如果获取绑定的 vpc 详情,则根据 zoneId 来调用接口 DescribeZoneInfo 来获取。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribePvtzStatisticsZoneOverview',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB\\",\\n \\"Data\\": {\\n \\"SuddenIncreaseDomainCount\\": 5,\\n \\"SuddenDropDomainCount\\": 3,\\n \\"RefusedDomainCount\\": 2\\n }\\n}","type":"json"}]',
],
'DescribeRegions' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '15409',
'abilityTreeNodes' => ['FEATUREpvtz18XH29'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'* **zh**:中文。'."\n"
."\n"
.'* **en**:英文。'."\n"
."\n"
.'默认:**en**'."\n"
."\n"
.'>优先级低于AcceptLanguage。', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '192.0.XX.XX'],
],
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => ['description' => '支持的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
.'- en-US:英文'."\n"
."\n"
.'默认:en-US'."\n"
.'>优先级高于Lang。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
[
'name' => 'AuthorizedUserId',
'in' => 'query',
'schema' => ['description' => '授权资源的所属用户主账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '141339776561****'],
],
[
'name' => 'VpcType',
'in' => 'query',
'schema' => ['description' => 'VPC类型。取值:'."\n"
."\n"
.'- STANDARD:标准VPC。'."\n"
."\n"
.'- EDS:无影工作区VPC。', 'type' => 'string', 'required' => false, 'example' => 'STANDARD'],
],
[
'name' => 'Scene',
'in' => 'query',
'schema' => ['description' => '场景信息。取值:'."\n"
."\n"
.'- AUTH:内置权威'."\n"
.'- FWD:转发管理'."\n"
.'- RA:流量分析', 'type' => 'string', 'required' => false, 'example' => 'AUTH'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '1E0F6898-F854-5133-A4CB-9C094152D05A'],
'Regions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Region' => [
'description' => '地域信息列表。',
'type' => 'array',
'items' => [
'description' => '地域信息详情。',
'type' => 'object',
'properties' => [
'LocalName' => ['description' => '地域的展示名,根据当前语言环境转换。', 'type' => 'string', 'example' => 'China (Shanghai)'],
'RegionName' => ['description' => '地域的名称。', 'type' => 'string', 'example' => 'China (Shanghai)'],
'RegionEndpoint' => ['description' => 'Region服务的Endpoint地址。', 'type' => 'string', 'example' => 'pvtz.aliyuncs.com'],
'RegionId' => ['description' => ' '."\n"
.'地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E0F6898-F854-5133-A4CB-9C094152D05A\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"LocalName\\": \\"China (Shanghai)\\",\\n \\"RegionName\\": \\"China (Shanghai)\\",\\n \\"RegionEndpoint\\": \\"pvtz.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"Message\\": \\"The request processing has failed due to some unknown error, exception or failure\\", \\n \\"RequestId\\": \\"E246E023-F2EB-4034-83F7-B13FCF31459C\\", \\n \\"Code\\": \\"InternalError\\"\\n}"},{"type":"xml","example":"\\n AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\n \\n \\n China North 2\\n cn-beijing\\n \\n \\n China South 1\\n cn-shenzhen\\n \\n \\n","errorExample":"\\n F0B47FE6-C774-4833-9028-B073588A8FAA\\n InternalError\\n The request processing has failed due to some unknown error, exception or failure\\n"}]',
'title' => '获取Region列表',
'summary' => '调用DescribeRegions接口获取可用地域列表供用户选择,可根据场景信息、vpc类型等进行筛选。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-01-06T04:15:31.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeRequestGraph' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户IP。', 'type' => 'string', 'required' => false, 'example' => '192.168.XX.XX'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID。'."\n"
.'>当查询Zone请求量数据时,可以传ZoneId或传BizType+BizId,两种方式取其中一种即可。', 'type' => 'string', 'required' => false, 'example' => '29c752a01cd281a20ddcfa****'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'Vpc ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-f8zvrvr1payllgz38****'],
],
[
'name' => 'StartTimestamp',
'in' => 'query',
'schema' => ['description' => '开始时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1721036404000'],
],
[
'name' => 'EndTimestamp',
'in' => 'query',
'schema' => ['description' => '结束时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1721723624000'],
],
[
'name' => 'BizType',
'in' => 'query',
'schema' => ['description' => '业务类型。取值:'."\n"
."\n"
.'- AUTH_ZONE:权威Zone。'."\n"
.'- RESOLVER_RULE:转发规则。', 'type' => 'string', 'required' => false, 'example' => 'AUTH_ZONE'],
],
[
'name' => 'BizId',
'in' => 'query',
'schema' => ['description' => '数据ID。配合BizType使用:'."\n"
."\n"
.'- BizType为AUTH_ZONE时传ZoneID。'."\n"
.'- BizType为RESOLVERRULE时传转发规则ID。', 'type' => 'string', 'required' => false, 'example' => 'b9c93a8954c4098731e863c04302f45a'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'EB71815-A421-4E51-8E8D-667F44ABE633'],
'RequestDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ZoneRequestTop' => [
'description' => '详情。',
'type' => 'array',
'items' => [
'description' => 'ZoneRequestTop请求量详情对象。',
'type' => 'object',
'properties' => [
'Time' => ['description' => '统计时间。', 'type' => 'string', 'example' => '2019-10-21T10:00Z'],
'RequestCount' => ['description' => '请求量。', 'type' => 'integer', 'format' => 'int64', 'example' => '103'],
'Timestamp' => ['description' => '统计时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1571652000000'],
],
],
],
],
],
],
],
],
],
'title' => '获取请求量详情',
'summary' => '调用DescribeRequestGraph,根据时间范围等条件查询请求量详情。',
'changeSet' => [
['createdAt' => '2024-07-08T02:09:51.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRequestGraph'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeRequestGraph',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EB71815-A421-4E51-8E8D-667F44ABE633\\",\\n \\"RequestDetails\\": {\\n \\"ZoneRequestTop\\": [\\n {\\n \\"Time\\": \\"2019-10-21T10:00Z\\",\\n \\"RequestCount\\": 103,\\n \\"Timestamp\\": 1571652000000\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeResolverAvailableZones' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ResolverRegionId',
'in' => 'query',
'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-zhangjiakou'],
],
[
'name' => 'AzId',
'in' => 'query',
'schema' => ['description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou-a'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '23268E49-0C3E-4A2C-AB70-B4C7D092470B'],
'AvailableZones' => [
'description' => '可用区资源状况列表。',
'type' => 'array',
'items' => [
'description' => '可用区资源信息。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '可用区内资源状态。描述:'."\n"
."\n"
.'- NORMAL: 正常'."\n"
.'- SOLD_OUT: 已售罄', 'type' => 'string', 'example' => 'NORMAL'],
'AzId' => ['description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-zhangjiakou-a'],
],
],
],
],
],
],
],
'title' => '获取可用区域列表',
'summary' => '调用DescribeResolverAvailableZones获取可用区域列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-11-05T03:01:33.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverAvailableZones'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:DescribeResolverAvailableZones',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"23268E49-0C3E-4A2C-AB70-B4C7D092470B\\",\\n \\"AvailableZones\\": [\\n {\\n \\"Status\\": \\"NORMAL\\",\\n \\"AzId\\": \\"cn-zhangjiakou-a\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"23268E49-0C3E-4A2C-AB70-B4C7D092470B\\n\\n NORMAL\\n cn-zhangjiakou-a\\n","errorExample":""}]',
],
'DescribeResolverEndpoint' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'EndpointId',
'in' => 'query',
'schema' => ['description' => '终端节点ID,终端节点的唯一标识。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hra0**'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '终端节点状态。描述:'."\n"
."\n"
.'- SUCCESS: 工作正常。'."\n"
.'- INIT:创建中。'."\n"
.'- FAILED:创建失败。'."\n"
.'- CHANGE_INIT: 修改中。'."\n"
.'- CHANGE_FAILED: 修改失败。'."\n"
.'- EXCEPTION: 工作异常。', 'type' => 'string', 'example' => 'SUCCESS'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '45020ED9-6319-4CA7-9475-6E8D6446E84F'],
'SecurityGroupId' => ['description' => '安全组ID,安全组里面的规则将应用于出站VPC。', 'type' => 'string', 'example' => 'sg-8vb3sigz86xc-group-****'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-07-13 10:45:56'],
'Name' => ['description' => '终端节点名称。', 'type' => 'string', 'example' => 'Endpoint-test'],
'VpcRegionName' => ['description' => '出站VPC所在地域名称。', 'type' => 'string', 'example' => 'North China'],
'VpcId' => ['description' => '出站专有网络ID(VPC ID),解析器所有出站的DNS查询流量都将经由此VPC进行流量转发。', 'type' => 'string', 'example' => 'vpc-0jl96awrjt75ezglc****'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-07-13 10:48:39'],
'VpcRegionId' => ['description' => '出站VPC所在的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'VpcName' => ['description' => '出站VPC名称。', 'type' => 'string', 'example' => 'vpc-name-test'],
'IpConfigs' => [
'description' => '出站流量源IP配置列表。',
'type' => 'array',
'items' => [
'description' => '出站流量源IP配置信息。',
'type' => 'object',
'properties' => [
'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-0jlgeyq4oazkh5xue****'],
'CidrBlock' => ['description' => '子网掩码,交换机的IPv4网段。', 'type' => 'string', 'example' => '172.16.XX.XX/24'],
'Ip' => ['description' => '子网掩码参数范围内的IP地址(留空则系统自动分配)。', 'type' => 'string', 'example' => '172.16.XX.XX'],
'AzId' => ['description' => '交换机所属的可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-a'],
],
],
],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1594608519000'],
'Id' => ['description' => '终端节点ID,终端节点的唯一标识。', 'type' => 'string', 'example' => 'hra0**'],
'CreateTimestamp' => ['description' => '创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1594608356000'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"45020ED9-6319-4CA7-9475-6E8D6446E84F\\",\\n \\"SecurityGroupId\\": \\"sg-8vb3sigz86xc-group-****\\",\\n \\"CreateTime\\": \\"2020-07-13 10:45:56\\",\\n \\"Name\\": \\"Endpoint-test\\",\\n \\"VpcRegionName\\": \\"North China\\",\\n \\"VpcId\\": \\"vpc-0jl96awrjt75ezglc****\\",\\n \\"UpdateTime\\": \\"2020-07-13 10:48:39\\",\\n \\"VpcRegionId\\": \\"cn-hangzhou\\",\\n \\"VpcName\\": \\"vpc-name-test\\",\\n \\"IpConfigs\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-0jlgeyq4oazkh5xue****\\",\\n \\"CidrBlock\\": \\"172.16.XX.XX/24\\",\\n \\"Ip\\": \\"172.16.XX.XX\\",\\n \\"AzId\\": \\"cn-hangzhou-a\\"\\n }\\n ],\\n \\"UpdateTimestamp\\": 1594608519000,\\n \\"Id\\": \\"hra0**\\",\\n \\"CreateTimestamp\\": 1594608356000\\n}","errorExample":""},{"type":"xml","example":"\\n SUCCESS\\n 45020ED9-6319-4CA7-9475-6E8D6446E84F\\n sg-8vb3sigz86xc-group-test\\n 2020-07-13 10:45:56\\n 终端节点-test\\n 华北\\n vpc-8vbl8mpum-vpc-id\\n 2020-07-13 10:48:39\\n cn-hangzhou\\n vpc-name-test\\n \\n vsw-8vbmks7hzrmk-vswitch-id\\n 172.16.0.0/24\\n 172.16.xx.xx\\n cn-hangzhou-a\\n \\n 1594608519000\\n hra0**\\n 1594608356000\\n","errorExample":""}]',
'title' => '获取终端节点详情',
'summary' => '调用DescribeResolverEndpoint根据终端节点ID获取终端节点详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverEndpoint'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeResolverEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz::{#accountId}:endpoint/{#EndpointId}'],
],
],
],
],
],
'DescribeResolverEndpoints' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => '终端节点名称关键字,使用模糊搜索的方式查询。', 'type' => 'string', 'required' => false, 'example' => 'Endpoint-test'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时设置查询的页码,起始值为 1,默认为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页数据量,最大值 100,默认为 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '终端节点状态。取值:'."\n"
."\n"
.'- SUCCESS: 工作正常。'."\n"
.'- INIT:创建中。'."\n"
.'- FAILED:创建失败。'."\n"
.'- CHANGE_INIT: 修改中。'."\n"
.'- CHANGE_FAILED: 修改失败。'."\n"
.'- EXCEPTION: 工作异常。'."\n"
."\n"
.'>不传获取全部,传入则获取指定状态。', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS'],
],
[
'name' => 'VpcRegionId',
'in' => 'query',
'schema' => ['description' => '出站VPC所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Endpoints' => [
'description' => '终端节点列表。',
'type' => 'array',
'items' => [
'description' => '节点信息。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '终端节点状态。描述:'."\n"
."\n"
.'- SUCCESS: 工作正常。'."\n"
.'- INIT:创建中。'."\n"
.'- FAILED:创建失败。'."\n"
.'- CHANGE_INIT: 修改中。'."\n"
.'- CHANGE_FAILED: 修改失败。'."\n"
.'- EXCEPTION: 工作异常。', 'type' => 'string', 'example' => 'SUCCESS'],
'VpcId' => ['description' => '出站专有网络ID(VPC ID),解析器所有出站的DNS查询流量都将经由此VPC进行流量转发。', 'type' => 'string', 'example' => 'vpc-0jlxhpfnj5bfu0bsd****'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-07-13 10:38:24'],
'SecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-0jld3m9yq7l2cw12****'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-07-13 10:36:26'],
'VpcRegionId' => ['description' => '出站VPC所在地域ID。', 'type' => 'string', 'example' => 'cn-zhangjiakou'],
'IpConfigs' => [
'description' => '出站流量源IP列表。',
'type' => 'array',
'items' => [
'description' => '出站流量源IP信息。',
'type' => 'object',
'properties' => [
'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-0jlgeyq4oazkh5xue****'],
'CidrBlock' => ['description' => '子网掩码,交换机的IPv4网段。', 'type' => 'string', 'example' => '172.16.XX.XX/24'],
'Ip' => ['description' => '子网掩码参数范围内的IP地址。', 'type' => 'string', 'example' => '172.16.XX.XX'],
'AzId' => ['description' => '交换机所属的可用区ID。', 'type' => 'string', 'example' => 'cn-zhangjiakou-a'],
],
],
],
'VpcName' => ['description' => '出站VPC名称。', 'type' => 'string', 'example' => 'vpc-test-name'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1594607904000'],
'VpcRegionName' => ['description' => '出站VPC所在地域名称。', 'type' => 'string', 'example' => 'Hangzhou VPC test'],
'Name' => ['description' => '终端节点名称。', 'type' => 'string', 'example' => 'Endpoint-test'],
'Id' => ['description' => '终端节点ID。', 'type' => 'string', 'example' => 'hr****'],
'CreateTimestamp' => ['description' => '创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1594607786000'],
],
],
],
'PageSize' => ['description' => '每页返回的数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '83D1682B-B69A-4060-9FA8-2907C2A35600'],
'PageNumber' => ['description' => '返回数据的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPages' => ['description' => '数据的总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalItems' => ['description' => '终端节点总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Endpoints\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"VpcId\\": \\"vpc-0jlxhpfnj5bfu0bsd****\\",\\n \\"UpdateTime\\": \\"2020-07-13 10:38:24\\",\\n \\"SecurityGroupId\\": \\"sg-0jld3m9yq7l2cw12****\\",\\n \\"CreateTime\\": \\"2020-07-13 10:36:26\\",\\n \\"VpcRegionId\\": \\"cn-zhangjiakou\\",\\n \\"IpConfigs\\": [\\n {\\n \\"VSwitchId\\": \\"vsw-0jlgeyq4oazkh5xue****\\",\\n \\"CidrBlock\\": \\"172.16.XX.XX/24\\",\\n \\"Ip\\": \\"172.16.XX.XX\\",\\n \\"AzId\\": \\"cn-zhangjiakou-a\\"\\n }\\n ],\\n \\"VpcName\\": \\"vpc-test-name\\",\\n \\"UpdateTimestamp\\": 1594607904000,\\n \\"VpcRegionName\\": \\"Hangzhou VPC test\\",\\n \\"Name\\": \\"Endpoint-test\\",\\n \\"Id\\": \\"hr****\\",\\n \\"CreateTimestamp\\": 1594607786000\\n }\\n ],\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"83D1682B-B69A-4060-9FA8-2907C2A35600\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n \\n SUCCESS\\n vpc-8vbl8mpum-test-vpc-id\\n 2020-07-13 10:38:24\\n sg-8vb3sigz86xc-test-group\\n 2020-07-13 10:36:26\\n cn-zhangjiakou\\n \\n vsw-8vbmks7h-test-vswitchId\\n 172.16.0.0/24\\n 172.16.xx.xx\\n cn-zhangjiakou-a\\n \\n vpc-test-name\\n 1594607904000\\n 杭州VPC测试\\n 终端节点-test\\n hra0**\\n 1594607786000\\n \\n 2\\n 83D1682B-B69A-4060-9FA8-2907C2A35600\\n 1\\n 1\\n 1\\n","errorExample":""}]',
'title' => '获取终端节点列表',
'summary' => '调用DescribeResolverEndpoints获取终端节点列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-07-09T05:33:11.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverEndpoints'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:DescribeResolverEndpoints',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz::{#accountId}:endpoint/*'],
],
],
],
],
],
'DescribeResolverRule' => [
'summary' => '调用DescribeResolverRule根据转发规则ID获取转发规则详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtzKODT3B'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '转发规则ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hr****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ForwardIps' => [
'description' => '转发目标IP地址列表。',
'type' => 'array',
'items' => [
'description' => '详情。',
'type' => 'object',
'properties' => [
'Ip' => ['description' => '转发目标IP地址。', 'type' => 'string', 'example' => '172.16.XX.XX'],
'Port' => ['description' => '转发目标端口号。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
],
],
],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '13D5113B-7E34-407F-A9C1-D96CD2B04277'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2020-07-13 10:51:44'],
'Name' => ['description' => '转发规则名称。', 'type' => 'string', 'example' => 'Forwarding rule-test'],
'ZoneName' => ['description' => '转发Zone名称。', 'type' => 'string', 'example' => 'example.com'],
'Type' => ['description' => '转发规则类型(目前仅支持选择转发至外部IP)。取值:'."\n"
."\n"
.'OUTBOUND: 转发至外部IP。', 'type' => 'string', 'example' => 'OUTBOUND'],
'EndpointName' => ['description' => '终端节点名称。', 'type' => 'string', 'example' => 'Endpoint-test'],
'EndpointId' => ['description' => '终端节点ID。', 'type' => 'string', 'example' => 'hr****'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2020-07-13 10:51:44'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1594608704000'],
'Id' => ['description' => '转发规则ID。', 'type' => 'string', 'example' => 'hr****'],
'CreateTimestamp' => ['description' => '创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1594608704000'],
'BindVpcs' => [
'description' => '转发规则关联的VPC列表。',
'type' => 'array',
'items' => [
'description' => '详情。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'Vpc ID。', 'type' => 'string', 'example' => 'vpc-f8zvrvr1payllgz38****'],
'VpcName' => ['description' => 'Vpc名称。', 'type' => 'string', 'example' => 'vpc-name-test'],
'VpcType' => ['description' => 'Vpc类型。说明:'."\n"
."\n"
.'- STANDARD:标准Vpc。'."\n"
."\n"
.'- EDS:无影工作区Vpc。', 'type' => 'string', 'example' => 'STANDARD'],
'RegionName' => ['description' => '地域名称。', 'type' => 'string', 'example' => 'Hangzhou test'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'VpcUserId' => ['description' => 'VPC归属用户ID。', 'type' => 'string', 'example' => '32454****'],
],
],
],
'BindEdgeDnsClusters' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClusterId' => ['type' => 'string', 'description' => ''],
'ClusterName' => ['type' => 'string', 'description' => ''],
'ClusterUserId' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
],
'description' => '',
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ForwardIps\\": [\\n {\\n \\"Ip\\": \\"172.16.XX.XX\\",\\n \\"Port\\": 80\\n }\\n ],\\n \\"RequestId\\": \\"13D5113B-7E34-407F-A9C1-D96CD2B04277\\",\\n \\"CreateTime\\": \\"2020-07-13 10:51:44\\",\\n \\"Name\\": \\"Forwarding rule-test\\",\\n \\"ZoneName\\": \\"example.com\\",\\n \\"Type\\": \\"OUTBOUND\\",\\n \\"EndpointName\\": \\"Endpoint-test\\",\\n \\"EndpointId\\": \\"hr****\\",\\n \\"UpdateTime\\": \\"2020-07-13 10:51:44\\",\\n \\"UpdateTimestamp\\": 1594608704000,\\n \\"Id\\": \\"hr****\\",\\n \\"CreateTimestamp\\": 1594608704000,\\n \\"BindVpcs\\": [\\n {\\n \\"VpcId\\": \\"vpc-f8zvrvr1payllgz38****\\",\\n \\"VpcName\\": \\"vpc-name-test\\",\\n \\"VpcType\\": \\"STANDARD\\",\\n \\"RegionName\\": \\"Hangzhou test\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcUserId\\": \\"32454****\\"\\n }\\n ],\\n \\"BindEdgeDnsClusters\\": [\\n {\\n \\"ClusterId\\": \\"\\",\\n \\"ClusterName\\": \\"\\",\\n \\"ClusterUserId\\": 0\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 172.16.xx.xx\\n 8080\\n \\n 13D5113B-7E34-407F-A9C1-D96CD2B04277\\n 2020-07-13 10:51:44\\n 转发规则-test\\n example.com\\n OUTBOUND\\n 终端节点-test\\n hra0**\\n 2020-07-13 10:51:44\\n 1594608704000\\n hra1**\\n 1594608704000\\n \\n vpc-8vbl8m-vpc-id\\n vpc-name-test\\n 杭州测试\\n cn-hangzhou\\n \\n","errorExample":""}]',
'title' => '获取转发规则详情',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-01-06T04:15:31.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverRule'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeResolverRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz::{#accountId}:rule/{#RuleId}'],
],
],
],
],
],
'DescribeResolverRules' => [
'summary' => '获取转发规则列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtzKODT3B'],
],
'parameters' => [
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => '”转发规则名称“关键字。支持模糊查询,不区分大小写。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时设置查询的页码,起始值为 1,默认为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页数据量,最大值 100,默认为 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
],
[
'name' => 'NeedDetailAttributes',
'in' => 'query',
'schema' => ['description' => '是否需要额外信息(转发规则关联的VPC列表)。取值:'."\n"
."\n"
.'- true:需要。'."\n"
.'- false:不需要。'."\n"
."\n"
.'默认值:false。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'EndpointId',
'in' => 'query',
'schema' => ['description' => '出站终端节点ID。', 'type' => 'string', 'required' => false, 'example' => 'hr****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '返回的每页数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'A10E03D7-808C-422D-9144-F8586C2E2297'],
'PageNumber' => ['description' => '返回数据的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPages' => ['description' => '全部数据的总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalItems' => ['description' => '总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Rules' => [
'description' => '转发规则列表。',
'type' => 'array',
'items' => [
'description' => '转发规则信息。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '转发规则类型(目前仅支持选择转发至外部IP)。取值:'."\n"
."\n"
.'OUTBOUND: 转发至外部IP。', 'type' => 'string', 'example' => 'OUTBOUND'],
'UpdateTime' => ['description' => '更新时间'."\n"
."\n", 'type' => 'string', 'example' => '2020-07-13 10:51:44'],
'ForwardIps' => [
'description' => '外部DNS系统IP地址和端口。DNS查询流量被转发的目标服务器的IP地址和端口。',
'type' => 'array',
'items' => [
'description' => '目标服务器的IP地址和端口。',
'type' => 'object',
'properties' => [
'Ip' => ['description' => '转发目标IP地址。', 'type' => 'string', 'example' => '172.16.XX.XX'],
'Port' => ['description' => '转发目标IP地址的端口号。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
],
],
],
'EndpointName' => ['description' => '终端节点名称。', 'type' => 'string', 'example' => 'Endpoint-test'],
'CreateTime' => ['description' => '创建时间'."\n"
."\n", 'type' => 'string', 'example' => '2020-07-13 10:51:44'],
'ZoneName' => ['description' => '需要转发解析请求的域名(Zone)。', 'type' => 'string', 'example' => 'example.com'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1594608704000'],
'BindVpcs' => [
'description' => '关联的VPC列表。',
'type' => 'array',
'items' => [
'description' => 'VPC信息。',
'type' => 'object',
'properties' => [
'VpcName' => ['description' => '专有网络名称(VPC Name)。', 'type' => 'string', 'example' => 'vpc-name-test'],
'VpcId' => ['description' => '专有网络ID(VPC ID),VPC唯一识别码。', 'type' => 'string', 'example' => 'vpc-0jl96awrjt75ezglc****'],
'VpcType' => ['description' => 'VPC类型。取值:'."\n"
."\n"
.'- STANDARD:标准VPC。'."\n"
."\n"
.'- EDS:无影工作区VPC。', 'type' => 'string', 'example' => 'STANDARD'],
'RegionName' => ['description' => 'VPC所属地域名称。', 'type' => 'string', 'example' => 'China (Ulanqab)'],
'RegionId' => ['description' => 'VPC所属地域ID。', 'type' => 'string', 'example' => 'cn-wulanchabu'],
'VpcUserId' => ['description' => 'VPC实际归属账号UID。', 'type' => 'string', 'example' => '141339776561****'],
],
],
],
'EndpointId' => ['description' => '终端节点ID。', 'type' => 'string', 'example' => 'hr****'],
'Name' => ['description' => '转发规则名称。', 'type' => 'string', 'example' => 'Forwarding rule-test'],
'Id' => ['description' => '转发规则Id。', 'type' => 'string', 'example' => 'hr****'],
'CreateTimestamp' => ['description' => '创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1594608704000'],
'BindEdgeDnsClusters' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClusterId' => ['type' => 'string', 'description' => ''],
'ClusterName' => ['type' => 'string', 'description' => ''],
'ClusterUserId' => ['type' => 'integer', 'format' => 'int64', 'description' => ''],
],
'description' => '',
],
'description' => '',
],
'PriorityForwardConfigs' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Protocol' => ['type' => 'string'],
'EnableStatus' => ['type' => 'string'],
'Priority' => ['type' => 'integer', 'format' => 'int32'],
'AlidnsServiceAddresses' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
'CustomAddresses' => [
'type' => 'array',
'items' => ['type' => 'string'],
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"A10E03D7-808C-422D-9144-F8586C2E2297\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1,\\n \\"Rules\\": [\\n {\\n \\"Type\\": \\"OUTBOUND\\",\\n \\"UpdateTime\\": \\"2020-07-13 10:51:44\\",\\n \\"ForwardIps\\": [\\n {\\n \\"Ip\\": \\"172.16.XX.XX\\",\\n \\"Port\\": 80\\n }\\n ],\\n \\"EndpointName\\": \\"Endpoint-test\\",\\n \\"CreateTime\\": \\"2020-07-13 10:51:44\\",\\n \\"ZoneName\\": \\"example.com\\",\\n \\"UpdateTimestamp\\": 1594608704000,\\n \\"BindVpcs\\": [\\n {\\n \\"VpcName\\": \\"vpc-name-test\\",\\n \\"VpcId\\": \\"vpc-0jl96awrjt75ezglc****\\",\\n \\"VpcType\\": \\"STANDARD\\",\\n \\"RegionName\\": \\"China (Ulanqab)\\",\\n \\"RegionId\\": \\"cn-wulanchabu\\",\\n \\"VpcUserId\\": \\"141339776561****\\"\\n }\\n ],\\n \\"EndpointId\\": \\"hr****\\",\\n \\"Name\\": \\"Forwarding rule-test\\",\\n \\"Id\\": \\"hr****\\",\\n \\"CreateTimestamp\\": 1594608704000,\\n \\"BindEdgeDnsClusters\\": [\\n {\\n \\"ClusterId\\": \\"\\",\\n \\"ClusterName\\": \\"\\",\\n \\"ClusterUserId\\": 0\\n }\\n ],\\n \\"PriorityForwardConfigs\\": [\\n {\\n \\"Protocol\\": \\"\\",\\n \\"EnableStatus\\": \\"\\",\\n \\"Priority\\": 0,\\n \\"AlidnsServiceAddresses\\": [\\n \\"\\"\\n ],\\n \\"CustomAddresses\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 10\\n A10E03D7-808C-422D-9144-F8586C2E2297\\n 1\\n 1\\n 1\\n \\n OUTBOUND\\n 2020-07-13 10:51:44\\n \\n 172.16.xx.xx\\n 8080\\n \\n 终端节点-test\\n 2020-07-13 10:51:44\\n example.com\\n 1594608704000\\n \\n vpc-name-test\\n vpc-8vbl8mpum-vpc-id\\n 杭州测试\\n cn-hangzhou\\n \\n hra0**\\n 转发规则-test\\n hra1**\\n 1594608704000\\n \\n","errorExample":""}]',
'title' => '获取转发规则列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-01-06T04:15:31.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverRules'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:DescribeResolverRules',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz::{#accountId}:rule/*'],
],
],
],
],
],
'DescribeStatisticSummary' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '昨日请求总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2254'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'A73F3BD0-B1A8-42A9-A9B6-689BBABC4891'],
'ZoneRequestTops' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ZoneRequestTop' => [
'description' => 'Zone请求量Top3(请求量最多的前三条数据)。',
'type' => 'array',
'items' => [
'description' => '详情。',
'type' => 'object',
'properties' => [
'RequestCount' => ['description' => '昨日请求量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2251'],
'ZoneName' => ['description' => 'Zone名称。', 'type' => 'string', 'example' => 'test.com'],
'BizType' => ['description' => '业务类型。描述:'."\n"
."\n"
.'- AUTH_ZONE:权威zone。'."\n"
.'- RESOLVER_RULE:转发规则。'."\n"
.'- INBOUND:入站终端节点', 'type' => 'string', 'example' => 'AUTH_ZONE'],
],
],
],
],
'description' => '',
],
'VpcRequestTops' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VpcRequestTop' => [
'description' => 'VPC请求量Top3(请求量最多的前三条数据)。',
'type' => 'array',
'items' => [
'description' => '详情。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-f8zvrvr1payllgz38****'],
'VpcType' => ['description' => 'vpc类型。描述:'."\n"
."\n"
.'- STANDARD:标准VPC。'."\n"
."\n"
.'- EDS:无影工作区VPC。', 'type' => 'string', 'example' => 'STANDARD'],
'RegionName' => ['description' => '地域名称。', 'type' => 'string', 'example' => 'China (Beijing)'],
'TunnelId' => ['description' => '隧道ID。', 'type' => 'string', 'example' => 'tun-7h33lkqfuhgnyy****'],
'RequestCount' => ['description' => '昨日请求量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2254'],
'RegionId' => ['description' => ' '."\n"
.'地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
],
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2254,\\n \\"RequestId\\": \\"A73F3BD0-B1A8-42A9-A9B6-689BBABC4891\\",\\n \\"ZoneRequestTops\\": {\\n \\"ZoneRequestTop\\": [\\n {\\n \\"RequestCount\\": 2251,\\n \\"ZoneName\\": \\"test.com\\",\\n \\"BizType\\": \\"AUTH_ZONE\\"\\n }\\n ]\\n },\\n \\"VpcRequestTops\\": {\\n \\"VpcRequestTop\\": [\\n {\\n \\"VpcId\\": \\"vpc-f8zvrvr1payllgz38****\\",\\n \\"VpcType\\": \\"STANDARD\\",\\n \\"RegionName\\": \\"China (Beijing)\\",\\n \\"TunnelId\\": \\"tun-7h33lkqfuhgnyy****\\",\\n \\"RequestCount\\": 2254,\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取昨日请求量概要',
'summary' => '调用DescribeStatisticSummary获取昨请求量概要,包括Zone请求量Top3信息和VPC请求量Top3信息。',
'responseParamsDescription' => 'BizType未填时返回参数说明:'."\n"
.'TotalCount:权威zone,转发zone,入站终端节点请求量总和'."\n"
.'ZoneRequestTops:权威zone,转发zone请求量Top(不包含入站终端节点请求量)'."\n"
.'VpcRequestTops:vpc内请求量总和Top(包含权威zone,转发zone,入站终端节点请求量)',
'changeSet' => [
['createdAt' => '2023-01-06T04:15:31.000Z', 'description' => '响应参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStatisticSummary'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeStatisticSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeSyncEcsHostTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'en'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'pvtz-test-id-2989149d628c5****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '主机名自动同步开关。取值:'."\n"
."\n"
.'- ON:开启(开启后,每隔1分钟,系统自动读取所选Region内的ECS主机名信息,并更新DNS记录)'."\n"
.'- OFF:关闭', 'type' => 'string', 'example' => 'ON'],
'ZoneId' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'example' => 'pvtz-test-id-2989149d628c56****'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '75446CC1-FC9A-4595-8D96-089D73D7A63D'],
'EcsRegions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EcsRegion' => [
'description' => '已同步的ECS地域信息。',
'type' => 'array',
'items' => [
'description' => '地域信息',
'type' => 'object',
'properties' => [
'UserId' => ['description' => '地域归属的用户ID,用于跨账号同步场景。', 'type' => 'integer', 'format' => 'int64', 'example' => '141339776561****'],
'RegionIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RegionId' => [
'description' => '已同步的地域ID列表。',
'type' => 'array',
'items' => ['description' => '已同步的地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
],
],
],
],
],
],
],
],
'Regions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RegionId' => [
'description' => '已同步的ECS地域Id。',
'type' => 'array',
'items' => ['description' => '已同步的地域ID。', 'type' => 'string', 'example' => 'cn-hongkong'],
],
],
],
'Success' => ['description' => '获取主机名同步任务详情是否成功。'."\n"
."\n"
.'- True'."\n"
.'- False', 'type' => 'boolean', 'example' => 'True'],
],
],
],
],
'title' => '获取主机名同步任务详情',
'summary' => '调用DescribeSyncEcsHostTask根据域名ID获取主机名同步任务详情。',
'changeSet' => [
['createdAt' => '2022-09-19T03:14:43.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSyncEcsHostTask'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeSyncEcsHostTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"ON\\",\\n \\"ZoneId\\": \\"pvtz-test-id-2989149d628c56****\\",\\n \\"RequestId\\": \\"75446CC1-FC9A-4595-8D96-089D73D7A63D\\",\\n \\"EcsRegions\\": {\\n \\"EcsRegion\\": [\\n {\\n \\"UserId\\": 0,\\n \\"RegionIds\\": {\\n \\"RegionId\\": [\\n \\"cn-beijing\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"Regions\\": {\\n \\"RegionId\\": [\\n \\"cn-hongkong\\"\\n ]\\n },\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n ON\\n pvtz-test-id-2989149d628c56f00e\\n 75446CC1-FC9A-4595-8D96-089D73D7A63D\\n \\n 1234567890\\n cn-beijing\\n \\n true\\n","errorExample":""}]',
],
'DescribeTags' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '资源类型:ZONE', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ZONE'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时设置查询的页码,起始值为 1,默认为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页数据量,最大值 100,默认为 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => '返回数据的总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'PageSize' => ['description' => '每页返回的数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '9EA7F720-B7C0-45C1-9CF4-B6A5A1179B68'],
'PageNumber' => ['description' => '返回数据的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Tags' => [
'description' => '资源标签列表。',
'type' => 'array',
'items' => [
'description' => '资源标签信息。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '资源标签键。', 'type' => 'string', 'example' => 'env'],
'Values' => [
'description' => '标签值列表。',
'type' => 'array',
'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'daily'],
],
],
],
],
],
],
],
],
'title' => '查询已有的标签列表',
'summary' => '调用DescribeTags查询内网DNS解析(PrivateZone)资源的标签列表。',
'description' => '#### **使用限制**'."\n"
.'目前仅支持查询Zone资源的标签信息。',
'changeSet' => [
['createdAt' => '2024-01-31T10:11:10.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 200,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"9EA7F720-B7C0-45C1-9CF4-B6A5A1179B68\\",\\n \\"PageNumber\\": 1,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Values\\": [\\n \\"daily\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeUserServiceStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '当前用户的服务状态:'."\n"
."\n"
.'- **CLOSED**:未开通'."\n"
.'- **OPENED**:已开通'."\n"
.'- **IN_DEBT**:已欠费'."\n"
.'- **IN_DEBT_OVER_DUE**: 欠费超期', 'type' => 'string', 'example' => 'OPENED'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '99626905-678A-4E8A-984E-6AEB09993996'],
],
],
],
],
'title' => '查询当前用户的服务状态',
'summary' => '查询当前用户的服务状态,例如是否开通服务,是否欠费等。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserServiceStatus'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeUserServiceStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"OPENED\\",\\n \\"RequestId\\": \\"99626905-678A-4E8A-984E-6AEB09993996\\"\\n}","errorExample":"{\\n \\"Message\\": \\"The request processing has failed due to some unknown error, exception or failure\\", \\n \\"RequestId\\": \\"E246E023-F2EB-4034-83F7-B13FCF31459C\\", \\n \\"Code\\": \\"InternalError\\"\\n}"},{"type":"xml","example":"\\n OPENED\\n 9EA7F720-B7C0-45C1-9CF4-B6A5A1179B68\\n","errorExample":"\\n F0B47FE6-C774-4833-9028-B073588A8FAA\\n InternalError\\n The request processing has failed due to some unknown error, exception or failure\\n"}]',
],
'DescribeUserVpcAuthorizations' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'AuthType',
'in' => 'query',
'schema' => ['description' => '授权类型。取值:'."\n"
."\n"
.'- NORMAL:普通授权。'."\n"
.'- CLOUD_PRODUCT:云产品授权。', 'type' => 'string', 'required' => false, 'example' => 'NORMAL'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时设置查询的页码,起始值为 1,默认为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999', 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页数据量,最大值 100,默认为 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '20'],
],
[
'name' => 'AuthorizedUserId',
'in' => 'query',
'schema' => ['description' => '授权资源的所属用户主账号ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '141339776561****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '返回的每页数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '46973D4C-E3E4-4ABA-9190-9A9DE406C7E'],
'PageNumber' => ['description' => '返回数据的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPages' => ['description' => '全部数据的总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'Users' => [
'description' => '授权资源的所属用户主账号信息。',
'type' => 'array',
'items' => [
'description' => '用户主账号信息。',
'type' => 'object',
'properties' => [
'AuthType' => ['description' => '授权类型。描述:'."\n"
."\n"
.'- NORMAL:普通授权。'."\n"
.'- CLOUD_PRODUCT:云产品授权。', 'type' => 'string', 'example' => 'NORMAL'],
'AuthorizedUserId' => ['description' => '授权资源的所属用户主账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '141339776561****'],
'AuthorizedAliyunId' => ['description' => '授权资源的所属用户主账号名称。', 'type' => 'string', 'example' => 'alidn****@test.com'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2023-05-08T02:31Z'."\n"],
'CreateTimestamp' => ['description' => '创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1672740294000'],
],
],
],
'TotalItems' => ['description' => '授权总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
],
'title' => '获取跨账号授权列表',
'summary' => '调用DescribeUserVpcAuthorizations获取跨账号授权列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2021-09-22T06:38:48.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserVpcAuthorizations'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeUserVpcAuthorizations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 5,\\n \\"Users\\": [\\n {\\n \\"AuthType\\": \\"NORMAL\\",\\n \\"AuthorizedUserId\\": 0,\\n \\"AuthorizedAliyunId\\": \\"alidn****@test.com\\",\\n \\"CreateTime\\": \\"2023-05-08T02:31Z\\\\n\\",\\n \\"CreateTimestamp\\": 1672740294000\\n }\\n ],\\n \\"TotalItems\\": 100\\n}","errorExample":""},{"type":"xml","example":"\\n 20\\n 46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\n 1\\n 5\\n \\n NORMAL\\n 111222333\\n alidns***@test.com\\n \\n 100\\n","errorExample":""}]',
],
'DescribeZoneInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtz18XH29'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'* **zh**:中文。'."\n"
."\n"
.'* **en**:英文。'."\n"
."\n"
.'默认:**en**', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'df2d03865266bd9842306db586d3****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'F73F41A3-B6DD-42CA-A793-FFF93277835D'],
'SlaveDns' => ['description' => '是否开启辅助DNS。取值:'."\n"
."\n"
.'- **true**:已开启'."\n"
.'- **false**:未开启', 'type' => 'boolean', 'example' => 'false'],
'ResourceGroupId' => ['description' => '当前Zone所属的资源组ID。', 'type' => 'string', 'example' => 'rg-acfmykd63gt****'],
'ZoneId' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'example' => 'df2d03865266bd9842306db586d3****'],
'ProxyPattern' => ['description' => '是否开启子域名递归代理。说明:'."\n"
."\n"
.'- ZONE: 关闭(当解析本域名下不存在的子域名时,直接返回NXDOMAIN,表示子域名不存在)'."\n"
."\n"
.'- RECORD: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)', 'type' => 'string', 'example' => 'ZONE'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2024-07-15T09:40Z'],
'ZoneType' => ['description' => 'Zone类型。说明:'."\n"
.'- **AUTH_ZONE**:权威Zone;'."\n"
.'- **CLOUD_PRODUCT_ZONE**:云产品权威Zone。', 'type' => 'string', 'example' => 'AUTH_ZONE'],
'Remark' => ['description' => '备注信息。', 'type' => 'string', 'example' => 'test'],
'ZoneName' => ['description' => 'Zone名称。', 'type' => 'string', 'example' => 'zone-test.cn'],
'ZoneTag' => ['description' => 'Zone标签。', 'type' => 'string', 'example' => 'pvtz'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2024-07-22T09:39Z'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1721641148000'],
'RecordCount' => ['description' => '当前Zone设置的解析记录总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'CreateTimestamp' => ['description' => ' '."\n"
.'创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1721036404000'],
'BindVpcs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Vpc' => [
'description' => '绑定的Vpc列表。',
'type' => 'array',
'items' => [
'description' => '绑定的Vpc列表。',
'type' => 'object',
'properties' => [
'VpcName' => ['description' => '专有网络(Vpc)名称。', 'type' => 'string', 'example' => 'vpc_test'],
'VpcId' => ['description' => 'Vpc ID,专有网络唯一标识。', 'type' => 'string', 'example' => 'vpc-f8zvrvr1payllgz38****'],
'VpcType' => ['description' => '专有网络(vpc)类型。说明:'."\n"
."\n"
.'- STANDARD:标准VPC。'."\n"
."\n"
.'- EDS:无影工作区VPC。', 'type' => 'string', 'example' => 'STANDARD'],
'RegionName' => ['description' => '专有网络(vpc)所属地域名称。', 'type' => 'string', 'example' => 'China (Heyuan)'],
'VpcUserId' => ['description' => '专有网络(vpc)归属的用户Id;若为null则归属当前用户。', 'type' => 'integer', 'format' => 'int64', 'example' => '141339776561****'],
'RegionId' => ['description' => '专有网络(vpc)所属地域ID。', 'type' => 'string', 'example' => 'cn-heyuan'],
],
],
],
],
],
'IsPtr' => ['description' => '是否反解zone。说明:'."\n"
.'- true:是反解zone'."\n"
.'- false:非反解zone', 'type' => 'boolean', 'example' => 'false'],
'DnsGroup' => ['description' => '内置权威位置区。说明:'."\n"
."\n"
.'- **NORMAL_ZONE**:普通区'."\n"
.'- **FAST_ZONE**:快速区', 'type' => 'string', 'example' => 'FAST_ZONE'],
'Creator' => ['description' => 'Zone创建者。', 'type' => 'string', 'example' => '141339776561****'],
'CreatorType' => ['description' => '创建者类型。', 'type' => 'string', 'example' => 'USER'],
'DnsGroupChanging' => ['description' => 'Zone切换位置区状态(普通区和快速区切换)。说明:'."\n"
."\n"
.'- true:切换中'."\n"
.'- false:未切换', 'type' => 'boolean', 'example' => 'false'],
'BindEdgeDnsClusters' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EdgeDnsCluster' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClusterId' => ['type' => 'string'],
'ClusterName' => ['type' => 'string'],
'ClusterUserId' => ['type' => 'integer', 'format' => 'int64'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified value parameter is not valid.', 'description' => ''],
['errorCode' => 'IllegalUser', 'errorMessage' => 'The user is illegal.', 'description' => ''],
['errorCode' => 'Zone.Invalid.Name', 'errorMessage' => 'Zone name is invalid.', 'description' => ''],
['errorCode' => 'Zone.Invalid.Id', 'errorMessage' => 'Zone id is invalid.', 'description' => 'Zone的ID不正确'],
['errorCode' => 'Zone.Invalid.UserId', 'errorMessage' => 'Zone userid is invalid.', 'description' => ''],
['errorCode' => 'Zone.NotExists', 'errorMessage' => 'Zone is not exists', 'description' => ''],
['errorCode' => 'Zone.VpcExists', 'errorMessage' => 'Zone have vpc bound.', 'description' => ''],
],
],
'title' => '获取zone详细信息',
'summary' => '调用DescribeZoneInfo获取指定内置权威域名(Zone)的详细信息,包括当前Zone绑定的VPC列表信息等。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-01-06T04:15:32.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZoneInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeZoneInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F73F41A3-B6DD-42CA-A793-FFF93277835D\\",\\n \\"SlaveDns\\": false,\\n \\"ResourceGroupId\\": \\"rg-acfmykd63gt****\\",\\n \\"ZoneId\\": \\"df2d03865266bd9842306db586d3****\\",\\n \\"ProxyPattern\\": \\"ZONE\\",\\n \\"CreateTime\\": \\"2024-07-15T09:40Z\\",\\n \\"ZoneType\\": \\"AUTH_ZONE\\",\\n \\"Remark\\": \\"test\\",\\n \\"ZoneName\\": \\"zone-test.cn\\",\\n \\"ZoneTag\\": \\"pvtz\\",\\n \\"UpdateTime\\": \\"2024-07-22T09:39Z\\",\\n \\"UpdateTimestamp\\": 1721641148000,\\n \\"RecordCount\\": 5,\\n \\"CreateTimestamp\\": 1721036404000,\\n \\"BindVpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"VpcName\\": \\"vpc_test\\",\\n \\"VpcId\\": \\"vpc-f8zvrvr1payllgz38****\\",\\n \\"VpcType\\": \\"STANDARD\\",\\n \\"RegionName\\": \\"China (Heyuan)\\",\\n \\"VpcUserId\\": 0,\\n \\"RegionId\\": \\"cn-heyuan\\"\\n }\\n ]\\n },\\n \\"IsPtr\\": false,\\n \\"DnsGroup\\": \\"FAST_ZONE\\",\\n \\"Creator\\": \\"141339776561****\\",\\n \\"CreatorType\\": \\"USER\\",\\n \\"DnsGroupChanging\\": false,\\n \\"BindEdgeDnsClusters\\": {\\n \\"EdgeDnsCluster\\": [\\n {\\n \\"ClusterId\\": \\"\\",\\n \\"ClusterName\\": \\"\\",\\n \\"ClusterUserId\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F73F41A3-B6DD-42CA-A793-FFF93277835D\\n true\\n rg-xxxxxxxx\\n AgIDE0OQ_149<\\n ZONE\\n 2018-01-23T03:15Z\\n CLOUD_PRODUCT_ZONE\\n specialZone\\n test.com\\n pvtz\\n 2018-01-24T06:35Z\\n 1516775741000\\n 2\\n 1516775741000\\n \\n daily-vpc-name\\n daily-vpc-id\\n 1304\\n cn-hangzhou\\n \\n false\\n","errorExample":""}]',
],
'DescribeZoneRecord' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RecordId',
'in' => 'query',
'schema' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5808'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0B7AD377-7E86-44A8-B9A8-53E8666E72FE'],
'Status' => ['description' => '解析记录状态。取值:'."\n"
.'- **ENABLE**: 启用解析 '."\n"
.'- **DISABLE**: 暂停解析', 'type' => 'string', 'example' => 'ENABLE'],
'Type' => ['description' => '解析记录类型。', 'type' => 'string', 'example' => 'A'],
'Value' => ['description' => '记录值。', 'type' => 'string', 'example' => '127.0.0.1'],
'Ttl' => ['description' => '生存时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'Remark' => ['description' => '备注。', 'type' => 'string', 'example' => 'test record'],
'RecordId' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '5808'],
'Rr' => ['description' => '主机记录。', 'type' => 'string', 'example' => 'www'],
'Priority' => ['description' => 'MX记录的优先级。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'Line' => ['description' => '解析线路。', 'type' => 'string', 'example' => 'default'],
'Weight' => ['description' => '解析记录权重。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2018-01-23T03:15Z'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2018-01-24T06:35Z'],
'CreateTimestamp' => ['description' => ' '."\n"
.'创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1516775741000'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1516775741000'],
'ZoneId' => ['description' => 'Zone ID。', 'type' => 'string', 'example' => 'CAgICA1OA_58'],
],
],
],
],
'title' => '查询解析记录详情',
'summary' => '查询解析记录详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZoneRecord'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeZoneRecord',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B7AD377-7E86-44A8-B9A8-53E8666E72FE\\",\\n \\"Status\\": \\"ENABLE\\",\\n \\"Type\\": \\"A\\",\\n \\"Value\\": \\"127.0.0.1\\",\\n \\"Ttl\\": 60,\\n \\"Remark\\": \\"test record\\",\\n \\"RecordId\\": 5808,\\n \\"Rr\\": \\"www\\",\\n \\"Priority\\": 5,\\n \\"Line\\": \\"default\\",\\n \\"Weight\\": 1,\\n \\"CreateTime\\": \\"2018-01-23T03:15Z\\",\\n \\"UpdateTime\\": \\"2018-01-24T06:35Z\\",\\n \\"CreateTimestamp\\": 1516775741000,\\n \\"UpdateTimestamp\\": 1516775741000,\\n \\"ZoneId\\": \\"CAgICA1OA_58\\"\\n}","type":"json"}]',
],
'DescribeZoneRecords' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => '主机记录的关键字,不区分大小写。你可已通过设置搜索模式(SearchMode)切换为“模糊搜索”或“精确搜索”,默认为“精确搜索”。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a96d70eb4ab8ef01503dc5486914****'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时设置查询的页码,起始值为 1,默认为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页数据量,最大值 100,默认为 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
[
'name' => 'Tag',
'in' => 'query',
'schema' => ['description' => '标签。取值:'."\n"
."\n"
.'- ecs:查询当前Zone同步的ECS主机名记录。'."\n"
.'- 为空:查询当前Zone的解析记录。', 'type' => 'string', 'required' => false, 'example' => 'ecs'],
],
[
'name' => 'SearchMode',
'in' => 'query',
'schema' => ['description' => '搜索模式。取值:'."\n"
."\n"
.'- **LIKE**:模糊搜索'."\n"
.'- **EXACT**:精确搜索(默认)'."\n"
."\n"
.'生效范围:Keyworld字段。', 'type' => 'string', 'required' => false, 'example' => 'EXACT'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '每页返回的数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '7B07FBC3-3A53-4939-A3C6-2BDFE407BAB2'],
'PageNumber' => ['description' => '返回数据的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPages' => ['description' => '返回数据的总量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalItems' => ['description' => '解析记录总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'Records' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Record' => [
'description' => '解析记录列表。',
'type' => 'array',
'items' => [
'description' => '解析记录详情。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '解析记录状态。描述:'."\n"
."\n"
.'- ENABLE:启用'."\n"
."\n"
.'- DISABLE:暂停', 'type' => 'string', 'example' => 'ENABLE'],
'Type' => ['description' => '解析记录类型。描述:'."\n"
.'- **A**:将域名指向一个IPV4'."\n"
.'- **AAAA**:将域名指向一个IPV6'."\n"
.'- **CNAME**:将域名指向另一个域名'."\n"
.'- **TXT**:文本长度限制255,通常做SPF记录(反垃圾邮件)'."\n"
.'- **MX**:将域名指向邮件服务器地址'."\n"
.'- **PTR**:将IP地址指向一个域名'."\n"
.'- **SRV**:记录提供特定的服务的服务器', 'type' => 'string', 'example' => 'A'],
'Value' => ['description' => '记录值。', 'type' => 'string', 'example' => '127.0.XX.XX'],
'Ttl' => ['description' => '本地缓存时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'Remark' => ['description' => '备注。', 'type' => 'string', 'example' => 'test'],
'RecordId' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '246959****'],
'Rr' => ['description' => '主机记录。', 'type' => 'string', 'example' => 'www'],
'Priority' => ['description' => 'MX记录的优先级。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Line' => ['description' => '解析线路。', 'type' => 'string', 'example' => 'default'],
'Weight' => ['description' => '权重值(1-100 内的整数,包括 1 和 100,默认为1),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-03-14T03:47Z'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2023-05-08T02:31Z'],
'CreateTimestamp' => ['description' => '创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1672740294000'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1654777678000'],
'ZoneId' => ['description' => 'Zone ID。', 'type' => 'string', 'example' => 'a49f55537f3b0b1e6e43add0bf5f****'],
],
],
],
],
],
],
],
],
],
'title' => '查询解析记录列表',
'summary' => '调用DescribeZoneRecords查询域名解析记录列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZoneRecords'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeZoneRecords',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 100,\\n \\"RequestId\\": \\"7B07FBC3-3A53-4939-A3C6-2BDFE407BAB2\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 100,\\n \\"Records\\": {\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"ENABLE\\",\\n \\"Type\\": \\"A\\",\\n \\"Value\\": \\"127.0.XX.XX\\",\\n \\"Ttl\\": 60,\\n \\"Remark\\": \\"test\\",\\n \\"RecordId\\": 0,\\n \\"Rr\\": \\"www\\",\\n \\"Priority\\": 10,\\n \\"Line\\": \\"default\\",\\n \\"Weight\\": 1,\\n \\"CreateTime\\": \\"2019-03-14T03:47Z\\",\\n \\"UpdateTime\\": \\"2023-05-08T02:31Z\\",\\n \\"CreateTimestamp\\": 1672740294000,\\n \\"UpdateTimestamp\\": 1654777678000,\\n \\"ZoneId\\": \\"a49f55537f3b0b1e6e43add0bf5f****\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeZoneVpcTree' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户 ip。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '7B07FBC3-3A53-4939-A3C6-2BDFE407BAB2'],
'Zones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Zone' => [
'description' => 'Zone 列表。',
'type' => 'array',
'items' => [
'description' => 'Zone详细信息。',
'type' => 'object',
'properties' => [
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2019-09-18T08:20Z'],
'ZoneType' => ['description' => 'Zone类型。描述:'."\n"
."\n"
.'- AUTH_ZONE:权威Zone。'."\n"
.'- CLOUD_PRODUCT_ZONE:云产品权威Zone。', 'type' => 'string', 'example' => 'AUTH_ZONE'],
'Remark' => ['description' => '备注信息。', 'type' => 'string', 'example' => 'demo'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2019-09-18T08:20Z'],
'Vpcs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Vpc' => [
'description' => '绑定的Vpc列表。',
'type' => 'array',
'items' => [
'description' => 'Vpc信息。',
'type' => 'object',
'properties' => [
'VpcName' => ['description' => 'Vpc名称。', 'type' => 'string', 'example' => 'demo-vpc'],
'VpcId' => ['description' => 'Vpc ID。VPC唯一识别码。', 'type' => 'string', 'example' => 'vpc-f8zvrvr1payllgz38****'],
'VpcType' => ['description' => 'Vpc类型。描述:'."\n"
."\n"
.'- STANDARD:标准VPC。'."\n"
."\n"
.'- EDS:无影工作区VPC。', 'type' => 'string', 'example' => 'STANDARD'],
'RegionName' => ['description' => 'Vpc所属地域名称。', 'type' => 'string', 'example' => 'China (Heyuan)'],
'RegionId' => ['description' => 'Vpc所属地域 ID。', 'type' => 'string', 'example' => 'cn-heyuan'],
],
],
],
],
],
'RecordCount' => ['description' => 'Zone解析记录条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ZoneName' => ['description' => 'Zone 名称。', 'type' => 'string', 'example' => 'example.com'."\n"],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568794834000'],
'ZoneId' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'example' => 'df2d03865266bd9842306db586d3****'],
'ZoneTag' => ['description' => '云产品类型。'."\n"
.'>- 若ZoneType为权威Zone,则此为空。'."\n"
.'>- 若ZoneType为云产品Zone,则此为云产品类型。', 'type' => 'string', 'example' => 'BLINK'],
'IsPtr' => ['description' => '是否是反解Zone。描述:'."\n"
."\n"
.'- true:是反解Zone'."\n"
.'- false:非反解Zone', 'type' => 'boolean', 'example' => 'false'],
'CreateTimestamp' => ['description' => '创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1568794812000'],
'DnsGroup' => ['description' => '内置权威位置区。描述:'."\n"
."\n"
.'- NORMAL_ZONE:普通区'."\n"
.'- FAST_ZONE:快速区', 'type' => 'string', 'example' => 'NORMAL_ZONE'],
'Creator' => ['description' => 'Zone创建者。', 'type' => 'string', 'example' => '141339776561****'],
'CreatorType' => ['description' => '操作者类型。', 'type' => 'string', 'example' => 'USER'],
'DnsGroupChanging' => ['description' => 'Zone切换位置区状态(普通区和快速区切换)。描述:'."\n"
."\n"
.'- true:切换中'."\n"
.'- false:未切换', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
],
],
],
'title' => '获取 Zone 列表和绑定的 VPC',
'summary' => '调用DescribeZoneVpcTree获取当前账号下Zone 列表及其绑定的 VPC 列表。',
'description' => '此接口性能不高,不建议使用。请使用 DescribeZones 获取 zone 列表。如果获取绑定的 vpc 详情,则根据 zoneId 来调用接口 DescribeZoneInfo 来获取。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2023-01-06T04:15:31.000Z', 'description' => '响应参数发生变更、错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZoneVpcTree'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:DescribeZoneVpcTree',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7B07FBC3-3A53-4939-A3C6-2BDFE407BAB2\\",\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"UpdateTime\\": \\"2019-09-18T08:20Z\\",\\n \\"ZoneType\\": \\"AUTH_ZONE\\",\\n \\"Remark\\": \\"demo\\",\\n \\"CreateTime\\": \\"2019-09-18T08:20Z\\",\\n \\"Vpcs\\": {\\n \\"Vpc\\": [\\n {\\n \\"VpcName\\": \\"demo-vpc\\",\\n \\"VpcId\\": \\"vpc-f8zvrvr1payllgz38****\\",\\n \\"VpcType\\": \\"STANDARD\\",\\n \\"RegionName\\": \\"China (Heyuan)\\",\\n \\"RegionId\\": \\"cn-heyuan\\"\\n }\\n ]\\n },\\n \\"RecordCount\\": 1,\\n \\"ZoneName\\": \\"example.com\\\\n\\",\\n \\"UpdateTimestamp\\": 1568794834000,\\n \\"ZoneId\\": \\"df2d03865266bd9842306db586d3****\\",\\n \\"ZoneTag\\": \\"BLINK\\",\\n \\"IsPtr\\": false,\\n \\"CreateTimestamp\\": 1568794812000,\\n \\"DnsGroup\\": \\"NORMAL_ZONE\\",\\n \\"Creator\\": \\"141339776561****\\",\\n \\"CreatorType\\": \\"USER\\",\\n \\"DnsGroupChanging\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A105C920-585C-49F2-B41C-98F147CDD945\\n \\n \\n 6d83e3b31aa60ca4aaa7161f1b6baa95\\n localzone.demo\\n 2019-09-18T08:20Z\\n 1568794812000\\n 1568794834000\\n 2019-09-18T08:20Z\\n false\\n 1\\n \\n \\n demo-vpc\\n China North 2\\n cn-beijing\\n vpc-2z21341ssdadsfzyd49ra\\n \\n \\n 测试\\n China North 2\\n cn-beijing\\n vpc-2ze21safadf23zyyg\\n \\n \\n \\n \\n fc1fc1dfbb6a7dc85dc8caa869ccee7a\\n 0.168.192.in-addr.arpa\\n 2019-10-15T03:47Z\\n 1571111261000\\n 2019-10-15T03:47Z\\n 1571111261000\\n true\\n 0\\n \\n \\n \\n \\n","errorExample":""}]',
],
'DescribeZones' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '15426',
'abilityTreeNodes' => ['FEATUREpvtz18XH29'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'en',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '分页查询时设置查询的页码,起始值为 1,默认为 1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '20', 'default' => '20'],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => 'Zone名称关键字,不区分大小写。你可通过设置搜索模式(SearchMode)切换为“精确搜索”或“模糊搜索”,默认为“模糊搜索”。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'SearchMode',
'in' => 'query',
'schema' => ['description' => '搜索模式(作用于Keyword参数)。取值:'."\n"
."\n"
.'- **LIKE**:模糊搜索(默认)'."\n"
.'- **EXACT**:精确搜索'."\n"
."\n"
.'默认值:**LIKE**', 'type' => 'string', 'required' => false, 'example' => 'EXACT'],
],
[
'name' => 'QueryRegionId',
'in' => 'query',
'schema' => ['description' => 'Zone关联VPC所属的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'QueryVpcId',
'in' => 'query',
'schema' => ['description' => '与zone关联的VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-f8zvrvr1payllgz38****'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'zone所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aekz2qj7awz****'],
],
[
'name' => 'ZoneType',
'in' => 'query',
'schema' => ['description' => 'Zone查询类型。取值:'."\n"
."\n"
.'- **AUTH_ZONE**: 查权威Zone列表。'."\n"
.'- **CLOUD_PRODUCT_ZONE**:使用的云产品Zone列表。'."\n"
."\n"
.'默认: **AUTH_ZONE**。', 'type' => 'string', 'required' => false, 'example' => 'AUTH_ZONE'],
],
[
'name' => 'ZoneTag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '云产品类型列表。',
'type' => 'array',
'items' => ['description' => '云产品类型。'."\n"
.' - 若查询权威Zone列表,则忽略此参数;'."\n"
.' - 若查询使用或者管理的云产品PrivateZone,则查询对应的云产品类型Zone列表。', 'type' => 'string', 'required' => false, 'example' => 'BLINK'],
'required' => false,
'maxItems' => 10000,
],
],
[
'name' => 'ResourceTag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '与zone关联的资源标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '资源标签键。', 'type' => 'string', 'required' => false, 'example' => 'env'],
'Value' => ['description' => '资源标签值。', 'type' => 'string', 'required' => false, 'example' => 'daily'],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '返回的每页数据量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B'],
'PageNumber' => ['description' => '返回数据的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPages' => ['description' => '全部数据的总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalItems' => ['description' => '全部数据的总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Zones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Zone' => [
'description' => 'zone列表。',
'type' => 'array',
'items' => [
'description' => 'zone对象详情。',
'type' => 'object',
'properties' => [
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2018-01-03T08:57Z'],
'ResourceTags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ResourceTag' => [
'description' => 'zone关联的资源标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '资源标签键。', 'type' => 'string', 'example' => 'env'],
'Value' => ['description' => '资源标签值。', 'type' => 'string', 'example' => 'daily'],
],
],
],
],
],
'ZoneType' => ['description' => 'Zone类型。说明:'."\n"
."\n"
.'- **AUTH_ZONE**: 权威Zone。'."\n"
.'- **CLOUD_PRODUCT_ZONE**: 云产品PrivateZone。', 'type' => 'string', 'example' => 'AUTH_ZONE'],
'Remark' => ['description' => 'zone的备注信息。', 'type' => 'string', 'example' => 'test'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2017-12-28T13:08Z'],
'RecordCount' => ['description' => 'zone解析记录数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'ZoneName' => ['description' => 'zone名称。', 'type' => 'string', 'example' => 'test.com'],
'ProxyPattern' => ['description' => '是否开启子域名递归代理。说明:'."\n"
.'- **ZONE**: 关闭(当解析本域名下不存在的子域名时,直接返回NXDOMAIN,表示子域名不存在)'."\n"
.'- **RECORD**: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)', 'type' => 'string', 'example' => 'ZONE'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514969843000'],
'ResourceGroupId' => ['description' => 'zone所属资源组ID。', 'type' => 'string', 'example' => 'rg-aekz2qj7awz****'],
'ZoneId' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'example' => '6d83e3b31aa60ca4aaa7161f1b6baa95'],
'ZoneTag' => ['description' => '云产品类型。'."\n"
."\n"
.'- 若ZoneType为权威zone,则此为空;'."\n"
.'- 若ZoneType为云产品zone,则此为云产品类型。', 'type' => 'string', 'example' => 'BLINK'],
'IsPtr' => ['description' => '是否为反解zone。说明:'."\n"
."\n"
.'- **true**:是反解zone'."\n"
.'- **false**:非反解zone', 'type' => 'boolean', 'example' => 'false'],
'CreateTimestamp' => ['description' => '创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1514466483000'],
'DnsGroup' => ['description' => '内置权威位置区。说明:'."\n"
."\n"
.'- **NORMAL_ZONE**:普通区'."\n"
.'- **FAST_ZONE**:快速区', 'type' => 'string', 'example' => 'NORMAL_ZONE'],
'Creator' => ['description' => 'zone创建者。', 'type' => 'string', 'example' => '546356****'],
'CreatorSubType' => ['description' => '账号类型。说明:'."\n"
.'- **CUSTOMER**:主账号'."\n"
.'- **SUB**:子账号'."\n"
.'- **STS**:角色扮演'."\n"
.'- **OTHER**:其他', 'type' => 'string', 'example' => 'SUB'],
'DnsGroupChanging' => ['description' => 'Zone切换位置区状态。'."\n"
."\n"
.'- **true**:切换中'."\n"
.'- **false**:未切换', 'type' => 'boolean', 'example' => 'false'],
'SlaveDnsStatus' => ['type' => 'string'],
],
],
],
],
],
],
],
],
],
'title' => '获取 zone 列表',
'summary' => '调用DescribeZones查询当前用户的Zone列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZones'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:DescribeZones',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1,\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"UpdateTime\\": \\"2018-01-03T08:57Z\\",\\n \\"ResourceTags\\": {\\n \\"ResourceTag\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"daily\\"\\n }\\n ]\\n },\\n \\"ZoneType\\": \\"AUTH_ZONE\\",\\n \\"Remark\\": \\"test\\",\\n \\"CreateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"RecordCount\\": 2,\\n \\"ZoneName\\": \\"test.com\\",\\n \\"ProxyPattern\\": \\"ZONE\\",\\n \\"UpdateTimestamp\\": 1514969843000,\\n \\"ResourceGroupId\\": \\"rg-aekz2qj7awz****\\",\\n \\"ZoneId\\": \\"6d83e3b31aa60ca4aaa7161f1b6baa95\\",\\n \\"ZoneTag\\": \\"BLINK\\",\\n \\"IsPtr\\": false,\\n \\"CreateTimestamp\\": 1514466483000,\\n \\"DnsGroup\\": \\"NORMAL_ZONE\\",\\n \\"Creator\\": \\"546356****\\",\\n \\"CreatorSubType\\": \\"SUB\\",\\n \\"DnsGroupChanging\\": false,\\n \\"SlaveDnsStatus\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListTagResources' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '资源类型:ZONE。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ZONE'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '下一个查询开始Token。取值在上一次调用后返回。', 'type' => 'string', 'required' => false, 'example' => '23423****'],
],
[
'name' => 'Size',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页数据量,最大值 200,默认为 20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表,即ZoneId列表。传入内容数量最大值为50',
'type' => 'array',
'items' => ['description' => '资源ID,即ZoneId。', 'type' => 'string', 'required' => false, 'example' => '97fe9321a476d0861f624d3f738d****'],
'required' => false,
'example' => '97fe9321a476d0861f624d3f738dcc38',
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签信息。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '资源标签键。', 'type' => 'string', 'required' => false, 'example' => 'env'],
'Value' => ['description' => '资源标签值。', 'type' => 'string', 'required' => false, 'example' => 'daily'],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一个查询开始Token,NextToken为空说明没有下一个。', 'type' => 'string', 'example' => '23423****'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '75446CC1-FC9A-4595-8D96-089D73D7A63D'],
'TagResources' => [
'description' => '标签资源列表。',
'type' => 'array',
'items' => [
'description' => '标签资源详情。',
'type' => 'object',
'properties' => [
'ResourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'ZONE'],
'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'daily'],
'ResourceId' => ['description' => '资源ID,即ZoneId。', 'type' => 'string', 'example' => '97fe9321a476d0861f624d3f738d****'],
'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'env'],
],
],
],
],
],
],
],
'title' => '查询资源标签关系列表',
'summary' => '调用ListTagResources查询内网DNS解析(PrivateZone)资源标签关系列表。',
'description' => '#### **使用限制**'."\n"
.'目前仅支持查询Zone资源的标签关系列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-31T10:11:10.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:ListTagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"23423****\\",\\n \\"RequestId\\": \\"75446CC1-FC9A-4595-8D96-089D73D7A63D\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"ZONE\\",\\n \\"TagValue\\": \\"daily\\",\\n \\"ResourceId\\": \\"97fe9321a476d0861f624d3f738d****\\",\\n \\"TagKey\\": \\"env\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"234235354\\n75446CC1-FC9A-4595-8D96-089D73D7A63D\\n\\n 75446CC1-FC9A-4595-8D96-089D73D7A63D\\n env\\n ZONE\\n daily\\n","errorExample":""}]',
],
'MoveResourceGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '支持的语言。取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认值:en。', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'df2d03865266bd9842306db586d4****'],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => ['description' => '目标资源组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rg-aekz2qj7awz****'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持ASCII字符,且不能超过64个字符。', 'type' => 'string', 'required' => false, 'example' => '21079fa016944979537637959d09bc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。'."\n"
."\n", 'type' => 'string', 'example' => 'D1324D48-1E23-4AEF-9EDE-466120561C6F'],
],
],
],
],
'title' => '更换资源组',
'summary' => '调用MoveResourceGroup接口更换资源组。',
'description' => '#### 限制条件'."\n"
.'该接口目前只支持Zone资源更换资源组。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveResourceGroup'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:MoveResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D1324D48-1E23-4AEF-9EDE-466120561C6F\\"\\n}","errorExample":""},{"type":"xml","example":"D1324D48-1E23-4AEF-9EDE-466120561C6F","errorExample":""}]',
],
'SearchCustomLines' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'chargeType' => 'free',
'abilityTreeCode' => '190583',
'abilityTreeNodes' => ['FEATUREpvtzNNOVSD'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '语言', 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '当前页数,起始值为**1**,默认为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999', 'minimum' => '1', 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页行数,最大值**100**,默认为**10**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '20'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '自定义线路名称', 'type' => 'string', 'required' => false, 'example' => 'Test'],
],
[
'name' => 'Ipv4',
'in' => 'query',
'schema' => ['description' => 'ipv4地址', 'type' => 'string', 'required' => false, 'example' => '1.1.1.1'],
],
[
'name' => 'Creator',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '创建者ID列表',
'type' => 'array',
'items' => ['description' => '创建者ID', 'type' => 'string', 'required' => false, 'example' => '21312421'],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'CreateTimestampStart',
'in' => 'query',
'schema' => ['description' => '起始创建时间(时间戳)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1672136518123'],
],
[
'name' => 'CreateTimestampEnd',
'in' => 'query',
'schema' => ['description' => '截止创建时间(时间戳)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1672136518234'],
],
[
'name' => 'UpdateTimestampStart',
'in' => 'query',
'schema' => ['description' => '起始修改时间(时间戳)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1672136515000'],
],
[
'name' => 'UpdateTimestampEnd',
'in' => 'query',
'schema' => ['description' => '截止修改时间(时间戳)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1672136518000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => '分页查询时设置的每页行数,最大值**100**,默认为**10**。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'RequestId' => ['description' => '唯一请求识别码'."\n", 'type' => 'string', 'example' => '46973D4C-E3E4-4ABA-9190-9A9DE406C7E'],
'PageNumber' => ['description' => '分页码 ,默认为1', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TotalPages' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'TotalItems' => ['description' => '总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'CustomLines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CustomLine' => [
'description' => '自定义线路列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LineId' => ['description' => '自定义线路唯一ID。', 'type' => 'string', 'example' => '11730'],
'Name' => ['description' => '自定义线路名称', 'type' => 'string', 'example' => '测试线路'],
'Ipv4s' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ipv4' => [
'description' => 'ipv4地址段列表',
'type' => 'array',
'items' => ['description' => 'ipv4地址段', 'type' => 'string', 'example' => '2.2.2.2'],
],
],
'description' => '',
],
'Creator' => ['description' => '创建者ID', 'type' => 'string', 'example' => '1851321989648462'],
'CreatorType' => ['description' => '创建者角色'."\n"
.'- USER 用户'."\n"
.'- SYSTEM 系统', 'type' => 'string', 'example' => 'USER'],
'CreatorSubType' => ['description' => '创建者类型'."\n"
.'- CUSTOM 主账号'."\n"
.'- SUB 子账号'."\n"
.'- STS 角色扮演'."\n"
.'- OTHER 其他角色', 'type' => 'string', 'example' => 'SUB'],
'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-12-27 18:16:38'],
'CreateTimestamp' => ['description' => ' '."\n"
.'创建时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1671174074000'],
'UpdateTime' => ['description' => '更新时间。', 'type' => 'string', 'example' => '2023-06-14 14:04:08'],
'UpdateTimestamp' => ['description' => '更新时间(时间戳)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1672136518000'],
'DnsCategory' => ['type' => 'string'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 5,\\n \\"TotalItems\\": 100,\\n \\"CustomLines\\": {\\n \\"CustomLine\\": [\\n {\\n \\"LineId\\": \\"11730\\",\\n \\"Name\\": \\"测试线路\\",\\n \\"Ipv4s\\": {\\n \\"Ipv4\\": [\\n \\"2.2.2.2\\"\\n ]\\n },\\n \\"Creator\\": \\"1851321989648462\\",\\n \\"CreatorType\\": \\"USER\\",\\n \\"CreatorSubType\\": \\"SUB\\",\\n \\"CreateTime\\": \\"2022-12-27 18:16:38\\",\\n \\"CreateTimestamp\\": 1671174074000,\\n \\"UpdateTime\\": \\"2023-06-14 14:04:08\\",\\n \\"UpdateTimestamp\\": 1672136518000,\\n \\"DnsCategory\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '搜索自定义线路',
'summary' => '搜索自定义线路。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchCustomLines'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:read',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'SetProxyPattern' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'df2d03865266bd9842306db586d3****'],
],
[
'name' => 'ProxyPattern',
'in' => 'query',
'schema' => ['description' => '是否开启子域名递归代理。取值:'."\n"
.'- **ZONE**: 关闭(当解析本域名下不存在的子域名时,直接返回NXDOMAIN,表示子域名不存在)'."\n"
.'- **RECORD**: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ZONE'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户IP。', 'type' => 'string', 'required' => false, 'example' => '10.61.XX.XX'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持ASCII字符,且不能超过64个字符。', 'type' => 'string', 'required' => false, 'example' => '21079fa016944979537637959d09bc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'Zone的全局ID。', 'type' => 'string', 'example' => 'df2d03865266bd9842306db586d3****'."\n"],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '0417DC19-11A0-5597-8717-2F705DE88925'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Zone.Remark', 'errorMessage' => '50 characters long. It can only contain numbers,Chinese,English and special characters: _ - , . ,。', 'description' => ''],
],
],
'title' => '设置递归解析代理',
'summary' => '调用SetProxyPattern设置子域名递归解析代理。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetProxyPattern'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:SetProxyPattern',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ZoneId\\": \\"df2d03865266bd9842306db586d3****\\\\n\\",\\n \\"RequestId\\": \\"0417DC19-11A0-5597-8717-2F705DE88925\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n D1324D48-1E23-4AEF-9EDE-466120561C6F\\r\\n AgIDE0OQ_149\\r\\n","errorExample":""}]',
],
'SetZoneRecordStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '207541****'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '解析记录状态。取值:'."\n"
."\n"
.'- ENABLE: 启用解析'."\n"
.'- DISABLE: 暂停解析',
'type' => 'string',
'required' => true,
'example' => 'ENABLE',
'enum' => ['ENABLE', 'DISABLE'],
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '127.XX.XX'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6447728c8578e66aacf062d2df4446dc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '当前解析记录状态。描述:'."\n"
."\n"
.'- ENABLE: 启用解析'."\n"
.'- DISABLE: 暂停解析', 'type' => 'string', 'example' => 'ENABLE'],
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '39CB16E5-4180-49F2-A060-23C0ECEB80D9'],
'RecordId' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '207541****'],
],
],
],
],
'title' => '设置解析记录状态',
'summary' => '调用SetZoneRecordStatus设置域名(Zone)析记录状态,启用或暂停解析。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetZoneRecordStatus'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:SetZoneRecordStatus',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"ENABLE\\",\\n \\"RequestId\\": \\"39CB16E5-4180-49F2-A060-23C0ECEB80D9\\",\\n \\"RecordId\\": 0\\n}","type":"json"}]',
],
'TagResources' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '资源类型:ZONE。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ZONE'],
],
[
'name' => 'OverWrite',
'in' => 'query',
'schema' => ['description' => '修改Tag列表。取值:'."\n"
."\n"
.'- True:全量覆盖原有Tag列表。'."\n"
.'- False(默认):在原有的Tag列表追加Tag,若Key相同Value不同,则覆盖Value。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表,即ZoneId列表。传入内容数量最大值为50。',
'type' => 'array',
'items' => ['description' => '资源ID,即zoneID。', 'type' => 'string', 'required' => false, 'example' => '97fe9321a476d0861f624d3f738d****'],
'required' => true,
'example' => '97fe9321a476d0861f624d3f738dcc38',
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签信息。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '资源标签键。', 'type' => 'string', 'required' => false, 'example' => 'env'],
'Value' => ['description' => '资源标签值。', 'type' => 'string', 'required' => false, 'example' => 'daily'],
],
'required' => false,
],
'required' => true,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。'."\n"
."\n", 'type' => 'string', 'example' => '75446CC1-FC9A-4595-8D96-089D73D7A63D'],
],
],
],
],
'title' => '标记资源',
'summary' => '调用TagResources标记内网DNS解析(PrivateZone)资源,批量增加或修改资源Zone的标签信息。',
'description' => '##### 使用限制'."\n"
.'目前仅支持设置Zone资源的标签信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-01-31T10:11:10.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"75446CC1-FC9A-4595-8D96-089D73D7A63D\\"\\n}","errorExample":""},{"type":"xml","example":"75446CC1-FC9A-4595-8D96-089D73D7A63D","errorExample":""}]',
],
'UntagResources' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '资源类型:ZONE。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ZONE'],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => '是否删除所有标签。取值:'."\n"
."\n"
.'- true :删除所传Zone的所有标签。'."\n"
.'- false :只删除指定标签键(TagKey.N)的标签。'."\n"
."\n"
.'默认:false', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源ID列表,即ZoneId列表。传入内容数量最大值为50。',
'type' => 'array',
'items' => ['description' => '资源ID,即ZoneId。', 'type' => 'string', 'required' => false, 'example' => '97fe9321a476d0861f624d3f738d****'],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源标签键列表。传入内容数量最大值为20。',
'type' => 'array',
'items' => ['description' => '资源标签键。', 'type' => 'string', 'required' => false, 'example' => 'env'],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '75446CC1-FC9A-4595-8D96-089D73D7A63D'],
],
],
],
],
'title' => '取消标记资源',
'summary' => '调用UntagResources取消内网DNS解析(PrivateZone)标记资源,批量删除Zone标签信息。',
'description' => '#### **使用限制**'."\n"
.'目前仅支持取消Zone资源的标记。',
'changeSet' => [
['createdAt' => '2024-01-31T10:11:10.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75446CC1-FC9A-4595-8D96-089D73D7A63D\\"\\n}","type":"json"}]',
],
'UpdateCustomLine' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '191236',
'abilityTreeNodes' => ['FEATUREpvtzNNOVSD'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '语言', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'en'],
],
[
'name' => 'LineId',
'in' => 'query',
'schema' => ['description' => '自定义线路唯一ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100003'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '自定义线路名称', 'type' => 'string', 'required' => false, 'example' => 'Test'],
],
[
'name' => 'Ipv4s',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'ipv4地址段列表',
'type' => 'array',
'items' => ['description' => 'ipv4地址段', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.1.1.1-2.2.2.2'],
'required' => true,
'docRequired' => true,
'maxItems' => 100,
],
],
[
'name' => 'DnsCategory',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码'."\n"
."\n", 'type' => 'string', 'example' => '0B7AD377-7E86-44A8-B9A8-53E8666E72FE'],
'LineId' => ['description' => '自定义线路唯一ID。', 'type' => 'string', 'example' => '765001'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CustomLine.IpOverlap', 'errorMessage' => 'customLine ip is overlap.%s', 'description' => '自定义线路ip段重叠'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B7AD377-7E86-44A8-B9A8-53E8666E72FE\\",\\n \\"LineId\\": \\"765001\\"\\n}","type":"json"}]',
'title' => '修改自定义线路',
'summary' => '修改自定义线路。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomLine'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:update',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'customLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/{#lineId}'],
],
],
],
],
],
'UpdateRecordRemark' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '202991****'],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'test record'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6447728c8578e66aacf062d2df4446dc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '0B7AD377-7E86-44A8-B9A8-53E8666E72FE'],
'RecordId' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '202991****'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Zone.Remark', 'errorMessage' => '50 characters long. It can only contain numbers,Chinese,English and special characters: _ - , . ,。', 'description' => ''],
],
],
'title' => '更新解析记录备注',
'summary' => '调用UpdateRecordRemark根据解析记录ID修改解析记录的备注信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRecordRemark'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateRecordRemark',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0B7AD377-7E86-44A8-B9A8-53E8666E72FE\\",\\n \\"RecordId\\": 0\\n}","type":"json"}]',
],
'UpdateResolverEndpoint' => [
'summary' => '调用UpdateResolverEndpoint修改终端节点。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREpvtz74JCUU'],
],
'parameters' => [
[
'name' => 'EndpointId',
'in' => 'query',
'schema' => ['description' => '终端节点ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hr****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '终端节点名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'endpoint-test-name'],
],
[
'name' => 'IpConfig',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '出站流量源IP地址列表(至少添加2个,最多可添加6个)。'."\n"
."\n"
.'>为了保证高可用,出站终端节点要求至少添加2个出站源IP地址,而且建议这2个IP地址分配在不同的可用区,出站终端节点允许添加的出站源IP地址最多为6个。',
'type' => 'array',
'items' => [
'description' => '出站流量源IP地址信息(如果修改此元素信息,除IP外,其他数据均为必填字段)',
'type' => 'object',
'properties' => [
'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-0jlgeyq4oazkh5xue****'."\n"],
'CidrBlock' => ['description' => '子网掩码,交换机的IPv4网段。', 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX/24'],
'AzId' => ['description' => '交换机的可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-a'],
'Ip' => ['description' => '子网掩码参数范围内的IP地址(留空则系统自动分配)。', 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX'],
],
'required' => false,
],
'required' => false,
'maxItems' => 12,
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'EC0BDA3A-A92A-4AC8-B351-322A9C79D5C5'],
],
],
],
],
'title' => '修改终端节点',
'changeSet' => [
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResolverEndpoint'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateResolverEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/{#EndpointId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EC0BDA3A-A92A-4AC8-B351-322A9C79D5C5\\"\\n}","errorExample":""},{"type":"xml","example":"EC0BDA3A-A92A-4AC8-B351-322A9C79D5C5","errorExample":""}]',
],
'UpdateResolverRule' => [
'summary' => '调用UpdateResolverRule修改转发规则。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREpvtzKODT3B'],
],
'parameters' => [
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '转发规则ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hr****'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '转发规则名称。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Forwarding rule-test'],
],
[
'name' => 'ForwardIp',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '外部DNS系统IP地址和端口列表。DNS查询流量被转发的目标服务器的IP地址和端口,最多创建6个,支持私网IP地址和公网IP地址。'."\n"
.'>若您填写的外部DNS服务器为公网IP,且您出站终端节点VPC内ECS无公网IP,请开通NAT网关并配置创建和管理VPC NAT网关的SNAT条目。',
'type' => 'array',
'items' => [
'description' => '详情。',
'type' => 'object',
'properties' => [
'Ip' => ['description' => '转发目标IP地址。'."\n"
."\n"
.'>以下地址段内的IP地址为系统预留地址,不允许被配置为外部DNS系统的IP地址'."\n"
.' 100.100.2.136-100.100.2.138'."\n"
.' 100.100.2.116-100.100.2.118', 'type' => 'string', 'required' => false, 'example' => '172.16.XX.XX'],
'Port' => ['description' => '转发目标IP地址的端口号。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8080'],
],
'required' => false,
],
'required' => false,
'maxItems' => 12,
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'EndpointId',
'in' => 'query',
'schema' => ['title' => '终端节点ID', 'description' => '终端节点ID。', 'type' => 'string', 'required' => false, 'example' => 'hr****'],
],
[
'name' => 'PriorityForwardConfigs',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Protocol' => ['type' => 'string', 'required' => false],
'EnableStatus' => ['type' => 'string', 'required' => false],
'Priority' => ['type' => 'integer', 'format' => 'int32'],
'AlidnsServiceAddresses' => [
'type' => 'array',
'items' => ['type' => 'string'],
'required' => false,
'maxItems' => 100,
],
'CustomAddresses' => [
'type' => 'array',
'items' => ['type' => 'string'],
'maxItems' => 100,
],
],
],
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '0C9959BE-3A6A-4803-8DCE-973B42ACD599'],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0C9959BE-3A6A-4803-8DCE-973B42ACD599\\"\\n}","errorExample":""},{"type":"xml","example":"0C9959BE-3A6A-4803-8DCE-973B42ACD599","errorExample":""}]',
'title' => '修改转发规则',
'changeSet' => [
['createdAt' => '2024-07-09T05:33:11.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2021-10-27T01:19:07.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResolverRule'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateResolverRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz:*:{#accountId}:rule/{#RuleId}'],
],
],
],
],
],
'UpdateSyncEcsHostTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'en'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'df2d03865266bd9842306db586d3****'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '主机同步任务状态。取值:'."\n"
."\n"
.'- ON:开启'."\n"
.'- OFF:关闭',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ON',
'enum' => ['OFF', 'ON'],
],
],
[
'name' => 'Region',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '待同步的地域信息列表。',
'type' => 'array',
'items' => [
'description' => '地域信息详情。',
'type' => 'object',
'properties' => [
'UserId' => ['description' => '地域归属的用户ID,用于跨账号同步场景。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '141339776561****'],
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
'required' => false,
],
'required' => true,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => 'test-FC9A-4595-8D96-089D73D7A63D'],
'Success' => ['description' => '是否成功。描述:'."\n"
."\n"
.'- True:成功'."\n"
.'- False:失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'title' => '更新主机名同步任务',
'summary' => '调用UpdateSyncEcsHostTask新增或更新主机名同步任务。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2024-07-08T01:49:12.000Z', 'description' => '错误码发生变更'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSyncEcsHostTask'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'pvtz:UpdateSyncEcsHostTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"test-FC9A-4595-8D96-089D73D7A63D\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n test-FC9A-4595-8D96-089D73D7A63D\\n true\\n","errorExample":""}]',
],
'UpdateZoneRecord' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Rr',
'in' => 'query',
'schema' => ['description' => '主机记录。主机记录就是域名前缀,常见用法有www、@、*(泛解析)、mail(常用于邮箱)'."\n"
."\n"
.'例如要解析@.exmaple.com,主机记录要填写"@”,而不是空。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'www'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认值:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => ['description' => '解析记录ID。可以通过调用DescribeZoneRecords查询解析记录列表获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '172223****'],
],
[
'name' => 'Line',
'in' => 'query',
'schema' => ['description' => '解析线路,默认:default。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'default'],
],
[
'name' => 'Weight',
'in' => 'query',
'schema' => ['description' => '权重值(1-100 内的整数,包括 1 和 100,默认为1),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '解析记录类型,目前支持如下:'."\n"
.'- **A**:将域名指向一个IPV4(点分十进制格式的IPv4地址)。'."\n"
.'- **AAAA**:将域名指向一个IPV6(IPv6地址)。'."\n"
.'- **CNAME**:将域名指向另一个域名(域名地址)。'."\n"
.'- **TXT**:文本长度限制255,通常做SPF记录(反垃圾邮件)。'."\n"
.'- **MX**:将域名指向邮件服务器地址(邮件服务器的域名)。'."\n"
.'- **PTR**:将IP地址指向一个域名。'."\n"
.'- **SRV**:记录提供特定的服务的服务器(格式为 优先级 权重 端口 目标地址,每项中间需以空格分隔)。'."\n"
.'> 添加PTR记录前需要先配置反解Zone,具体操作请参考[反向解析及PTR记录](~~2592976~~)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'A'],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => ['description' => '本地缓存时间。目前取值仅支持5、30、60、3600(1小时)、43200(12小时)、86400(一天),单位秒(s)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '86400', 'minimum' => '5', 'example' => '60', 'default' => '60'],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => ['description' => 'MX记录的优先级。可以为不同邮件服务器设置优先级,优先级取值 1-99,取值越小,优先级越高。'."\n"
.'>记录类型为MX记录时,此参数必选。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99', 'minimum' => '1', 'example' => '1', 'default' => ''],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['description' => '记录值。根据不同解析记录类型,填写相应的记录值。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '192.16.XX.XX'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户Ip。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。', 'type' => 'string', 'required' => false, 'example' => '6447728c8578e66aacf062d2df4446dc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '唯一请求识别码。', 'type' => 'string', 'example' => '250E2C38-D0AD-4518-851D-1C1055805F82'],
'RecordId' => ['description' => '解析记录ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '172223****'],
],
],
],
],
'title' => '修改解析记录',
'summary' => '调用UpdateZoneRecord修改域名(Zone)的解析记录,包括主机记录、解析记录、权重等。',
'description' => '#### **注意事项**'."\n"
.'普通区域名修改解析记录至少需要等待TTL到期后才能全部生效,加速区域名修改解析记录立即生效,不受TTL值影响。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateZoneRecord'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateZoneRecord',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"250E2C38-D0AD-4518-851D-1C1055805F82\\",\\n \\"RecordId\\": 0\\n}","type":"json"}]',
],
'UpdateZoneRemark' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '返回值语言,取值:'."\n"
."\n"
.'- zh:中文。'."\n"
."\n"
.'- en:英文。'."\n"
."\n"
.'默认:en', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'required' => true, 'example' => 'df2d03865266bd9842306db586d3****'],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => '修改之后的备注内容(不填则设置Remark为空)。', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => ['description' => '用户客户端IP。', 'type' => 'string', 'required' => false, 'example' => '127.0.XX.XX'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持ASCII字符,且不能超过64个字符。', 'type' => 'string', 'required' => false, 'example' => '21079fa016944979537637959d09bc'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ZoneId' => ['description' => 'Zone ID,Zone的唯一识别码。', 'type' => 'string', 'example' => 'df2d03865266bd9842306db586d3****'],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Zone.Remark', 'errorMessage' => '50 characters long. It can only contain numbers,Chinese,English and special characters: _ - , . ,。', 'description' => ''],
],
],
'title' => '修改zone的备注信息',
'summary' => '调用UpdateZoneRemark修改内置权威域名(zone)的备注信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateZoneRemark'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateZoneRemark',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ZoneId\\": \\"df2d03865266bd9842306db586d3****\\",\\n \\"RequestId\\": \\"C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB\\"\\n}","errorExample":"{\\n \\"Message\\": \\"The request processing has failed due to some unknown error, exception or failure\\", \\n \\"RequestId\\": \\"E246E023-F2EB-4034-83F7-B13FCF31459C\\", \\n \\"Code\\": \\"InternalError\\"\\n}"},{"type":"xml","example":"\\n D1324D48-1E23-4AEF-9EDE-466120561C6F\\n AgIDE0OQ_149\\n","errorExample":"\\n F0B47FE6-C774-4833-9028-B073588A8FAA\\n InternalError\\n The request processing has failed due to some unknown error, exception or failure\\n"}]',
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-south-1', 'regionName' => '印度(孟买)已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云(邀测)', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'pvtz.aliyuncs.com', 'endpoint' => 'pvtz.aliyuncs.com', 'vpc' => 'pvtz.vpc-proxy.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'CacheReserveDomain.EffectiveScopeEmpty', 'message' => 'Effective scope is empty.', 'http_code' => 400, 'description' => '缓存保持域名没有关联生效范围'],
['code' => 'CacheReserveDomain.Vpc.Maximum', 'message' => 'CacheReserveDomain bound vpc count exceed the maximum.', 'http_code' => 400, 'description' => '缓存保持域名绑定vpc数量超过最大数量限制'],
['code' => 'CustomLine.InUsed', 'message' => 'customLine is in used can not delete.%s', 'http_code' => 400, 'description' => '自定义线路被引用无法删除'],
['code' => 'CustomLine.IpOverlap', 'message' => 'customLine ip is overlap.%s', 'http_code' => 400, 'description' => '自定义线路ip段重叠'],
['code' => 'EdgeDns.CallEdgeDnsServerFailed', 'message' => 'Call edge dns server failed.', 'http_code' => 400, 'description' => '调用自建DNS服务器失败。'],
['code' => 'Edgedns.Cluster.AppVersionExpired', 'message' => 'Edge dns cluster app version is expired.', 'http_code' => 400, 'description' => '自建DNS集群软件版本已过期。'],
['code' => 'EdgeDns.Cluster.BindCountExceedLimit', 'message' => 'The number of clusters bound to the resource exceeds the limit.', 'http_code' => 400, 'description' => '资源关联的自建DNS解析集群超过上限。'],
['code' => 'EdgeDns.Cluster.CacheReserveDomainDuplicate', 'message' => 'Edge dns cluster is bind to same domain name.', 'http_code' => 400, 'description' => '自建DNS集群关联了同名的缓存保持域名。'],
['code' => 'Edgedns.Cluster.ForbiddenRetryResourceActionJob', 'message' => 'Access forbidden to retry resource action job.', 'http_code' => 400, 'description' => '已有进行中的数据同步任务,禁止重复提交。'],
['code' => 'EdgeDns.Cluster.NoNodes', 'message' => 'Cluster does not have nodes.', 'http_code' => 400, 'description' => '自建DNS集群下无有效节点。'],
['code' => 'EdgeDns.Cluster.NotBelongToUser', 'message' => 'Cluster does not belong to user.', 'http_code' => 400, 'description' => '自建DNS集群不属于当前用户。'],
['code' => 'EdgeDns.Cluster.NotExists', 'message' => 'Cluster does not exist.', 'http_code' => 400, 'description' => '自建DNS集群不存在'],
['code' => 'Edgedns.Cluster.NotSupportCurrentEnv', 'message' => 'Edge dns cluster not support current env.', 'http_code' => 400, 'description' => '自建DNS集群环境属性非法。'],
['code' => 'Edgedns.Cluster.NotSupportOperator', 'message' => 'Edge dns cluster not support operator.', 'http_code' => 400, 'description' => '不支持操作自建DNS运维集群'],
['code' => 'EdgeDns.Cluster.ResolveRuleDuplicate', 'message' => 'Edge dns cluster is bind to same forward zone name.', 'http_code' => 400, 'description' => '自建DNS集群关联了同名的转发规则。'],
['code' => 'EdgeDns.Cluster.ZoneDuplicate', 'message' => 'Edge dns cluster is bind to same authority zone name.', 'http_code' => 400, 'description' => '自建DNS集群关联了同名权威Zone'],
['code' => 'EdgeDns.InvalidResourceType', 'message' => 'The resource type is invalid.', 'http_code' => 400, 'description' => '自建DNS删除节点时,查询的资源类型不合法'],
['code' => 'EdgeDns.InvalidUserId', 'message' => 'The user id is invalid.', 'http_code' => 400, 'description' => '用户id不合法'],
['code' => 'InboundEndpoint.InvalidId', 'message' => 'The inboundEndpoint id is invalid.', 'http_code' => 400, 'description' => '入站终端节点Id无效'],
['code' => 'InboundEndpoint.InvalidSecurityGroupId', 'message' => 'The specified security group id is invalid.', 'http_code' => 400, 'description' => '入站终端节点安全组id无效'],
['code' => 'InboundEndpoint.InvalidSpecVersion', 'message' => 'The inboundEndpoint spec version is invalid.', 'http_code' => 400, 'description' => '入站终端节点规格版本无效'],
['code' => 'InboundEndpoint.InvalidStatus', 'message' => 'The inboundEndpoint status is invalid.', 'http_code' => 400, 'description' => '入站终端节点设置状态无效'],
['code' => 'InboundEndpoint.InvalidUserId', 'message' => 'The UserId parameter is invalid.', 'http_code' => 400, 'description' => '入站终端节点用户Id无效'],
['code' => 'InboundEndpoint.InvalidVpcId', 'message' => 'The specified vpc is invalid.', 'http_code' => 400, 'description' => '入站终端节点vpc id无效'],
['code' => 'InboundEndpoint.Ipconfig.BelowMinimum', 'message' => 'The number of source IP addresses that are specified for outbound traffic below minimum.', 'http_code' => 400, 'description' => '入站终端节点服务IP地址数量低于最小限制'],
['code' => 'InboundEndpoint.Ipconfig.DuplicateIp', 'message' => 'The specific ip has duplicated with exist one.', 'http_code' => 400, 'description' => '入站终端节点服务IP地址重复'],
['code' => 'InboundEndpoint.Ipconfig.DuplicateIpWithForwardIp', 'message' => 'The specific IP has duplicated with forward IP.', 'http_code' => 400, 'description' => '入站终端节点服务IP与同VPC内出站终端节点关联的转发规则目的IP重复'],
['code' => 'InboundEndpoint.Ipconfig.DuplicateIpWithResolverEndpointIp', 'message' => 'The specific IP has duplicated with resolver endpoint IP.', 'http_code' => 400, 'description' => '入站终端节点服务IP与同VPC内出站终端节点服务P重复'],
['code' => 'InboundEndpoint.Ipconfig.ExceedsLimit', 'message' => 'The number of source IP addresses that are specified for outbound traffic exceeds the upper limit.', 'http_code' => 400, 'description' => '入站终端节点服务IP地址数量超过最大限制'],
['code' => 'InboundEndpoint.Ipconfig.InvalidAzId', 'message' => 'The specified az id is invalid.', 'http_code' => 400, 'description' => '入站终端节点服务IP地址的可用区id无效'],
['code' => 'InboundEndpoint.Ipconfig.InvalidCidrBlock', 'message' => 'The specified cidrBlock is invalid.', 'http_code' => 400, 'description' => '入站终端节点服务IP地址的子网掩码无效'],
['code' => 'InboundEndpoint.Ipconfig.InvalidIp', 'message' => 'The specified IP address is invalid.', 'http_code' => 400, 'description' => '入站终端节点服务IP地址无效'],
['code' => 'InboundEndpoint.Ipconfig.InvalidVSwitch', 'message' => 'The specified vswitch is invalid.', 'http_code' => 400, 'description' => '入站终端节点服务IP地址的交换机id无效'],
['code' => 'InboundEndpoint.Name.Duplicate', 'message' => 'The specified endpoint name is the same as an existing endpoint name.', 'http_code' => 400, 'description' => '入站终端节点名称重复'],
['code' => 'InboundEndpoint.Name.ExceedsLength', 'message' => 'The maximum length of an endpoint name is reached.', 'http_code' => 400, 'description' => '入站终端节点名称超过长度限制'],
['code' => 'InboundEndpoint.NotExsits', 'message' => 'The inboundEndpoint is not Exsit.', 'http_code' => 400, 'description' => '入站终端节点不存在'],
['code' => 'InboundEndpoint.Num.ExceedsLimit', 'message' => 'The maximum number of endpoints is reached.', 'http_code' => 400, 'description' => '入站终端节点数量超过最大限制'],
['code' => 'InboundEndpoint.OperationForbidden.Status', 'message' => 'The specific status of endpoint is unsupported for operation.', 'http_code' => 400, 'description' => '入站终端节点处于不可操作的状态'],
['code' => 'InboundEndpoint.Region.Unsupported', 'message' => 'The specific region is unsupported for resolver.', 'http_code' => 400, 'description' => '入站终端节点不支持该region'],
['code' => 'InboundEndpoint.SystemAssignUnsupportedOperation', 'message' => 'The system assign inboundEndpoint unsupported operation.', 'http_code' => 400, 'description' => '系统分配入站终端节点不支持该操作'],
['code' => 'InternalError', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 400, 'description' => '内部错误'],
['code' => 'InvalidRegionId', 'message' => 'Invalid region id.', 'http_code' => 400, 'description' => '无效的地域ID参数。'],
['code' => 'InvalidVpcId', 'message' => 'Invalid vpc id.', 'http_code' => 400, 'description' => '无效的VPC ID。'],
['code' => 'InvalidVpcType', 'message' => 'Invalid vpc type.', 'http_code' => 400, 'description' => '无效的VPC类型'],
['code' => 'InvalidVpcUserId', 'message' => 'Invalid vpc user id.', 'http_code' => 400, 'description' => '无效的VpcUserId参数'],
['code' => 'PostBusiness.InvalidService', 'message' => 'post business service not activated.', 'http_code' => 400, 'description' => '后付费服务没有开通'],
['code' => 'PostBusiness.InvalidServiceModule', 'message' => 'post business service module not activated.', 'http_code' => 400, 'description' => '后付费服务模块没有开通'],
['code' => 'ResolveAnalysis.Forbidden.AliyunInnerUid', 'message' => 'Aliyun Inner account, operation prohibited.', 'http_code' => 400, 'description' => '阿里云内部账号禁止操作,请联系云解析DNS团队处理。'],
['code' => 'ResolverEndpoint.Id.Invalid', 'message' => 'The endpoint id invalid.', 'http_code' => 400, 'description' => '终端节点ID无效'],
['code' => 'ResolverEndpoint.IpConfig.DuplicateIpWithInbound', 'message' => 'The specific Ip has duplicated with inbound endpoint Ip.', 'http_code' => 400, 'description' => '出站终端节点ip与入站终端节点ip重复'],
['code' => 'ResolverRule.BindEdgeDnsCluster', 'message' => 'The forwarding rule is already bound to a edge dns cluster.', 'http_code' => 400, 'description' => '转发规则已关联自建集群'],
['code' => 'ResolverRule.Endpoint.RegionNotConsistent', 'message' => 'The region of the endpoint of the forwarding rule is inconsistent with the region bound to the VPC.', 'http_code' => 400, 'description' => '转发规则终端节点地域和绑定Vpc的地域不一致'],
['code' => 'ResolverRule.ForwardIps.InboundForbidden', 'message' => 'The specified destination IP address is forbidden for the inbound.', 'http_code' => 400, 'description' => '转发规则外部DNS系统的IP地址与入站终端节点ip重复,禁止添加'],
['code' => 'Resource.EffectiveScope.OperationTypeInvalid', 'message' => 'Invalid operation type.', 'http_code' => 400, 'description' => '操作类型无效。'],
['code' => 'SlaveDns.BoundVPCandClusterForbidden', 'message' => 'Zone that support secondary DNS cannot bind both VPC and cluster.', 'http_code' => 400, 'description' => '配置辅助DNS的ZONE不能同时绑定VPC与自建DNS集群'],
['code' => 'SlaveDns.EdgeClusterAdded', 'message' => 'Secondary DNS of cluster has already been added. Please delete it before the operation.', 'http_code' => 400, 'description' => 'ZONE已经配置辅助DNS功能,请删除后再进行绑定自建DNS集群'],
['code' => 'SlaveDns.RegionVpcAdded', 'message' => 'Secondary DNS of private zone has already been added. Please delete it before the operation.', 'http_code' => 400, 'description' => 'ZONE已经配置辅助DNS功能,请删除后再进行绑定VPC'],
['code' => 'Sys.SpeedLimit.OutOfLimit', 'message' => 'The accept speed is out of limit.', 'http_code' => 400, 'description' => '访问频率超过限制'],
['code' => 'Throttling.User', 'message' => 'Request was denied due to user flow control.', 'http_code' => 400, 'description' => '由于请求频次达到阈值,请求被拒绝,请稍后重试。'],
['code' => 'Zone.BindEdgeDnsCluster', 'message' => 'Zone is already bound to a edge dns cluster.', 'http_code' => 400, 'description' => '权威Zone已绑定该集群,不可操作。'],
['code' => 'Zone.BindEdgeDnsCluster.OnlySupportFastZone', 'message' => 'Binding an Edge DNS cluster is only supported for Fast Zones.', 'http_code' => 400, 'description' => '仅快速区权威Zone支持关联自建DNS集群。'],
['code' => 'Zone.BindEdgeDnsCluster.RecordCountExceed', 'message' => 'You cannot bind the cluster, because record count exceed the maximum.', 'http_code' => 400, 'description' => '权威Zone下解析记录数量超过上限。禁止关联自建DNS集群。'],
['code' => 'Zone.DnsGroupChange.Forbidden', 'message' => 'You cannot change dns group.', 'http_code' => 400, 'description' => '禁止切换位置区'],
['code' => 'Zone.DnsGroupChange.Forbidden4FastZone', 'message' => 'You cannot change dns group, because can only use fast zone.', 'http_code' => 400, 'description' => '当前zone被禁止进行位置区切换,因为用户只能使用快速区。'],
['code' => 'Zone.Invalid.Id', 'message' => 'Zone id is invalid.', 'http_code' => 400, 'description' => 'Zone的ID不正确'],
['code' => 'ResolverRule.PriorityForwardConfig.StatusInvalid', 'message' => 'The status of the priority forward configuration is invalid.', 'http_code' => 400, 'description' => '优先转发配置的状态参数非法'],
['code' => 'ResolverRule.PriorityForwardConfig.CustomAddressInvalid', 'message' => 'The custom address of the priority forward configuration is invalid.', 'http_code' => 400, 'description' => '优先转发配置的自定义HttpDNS地址非法'],
['code' => 'ResolverRule.PriorityForwardConfig.ProtocolInvalid', 'message' => 'The protocol of the priority forward configuration is invalid.', 'http_code' => 400, 'description' => '优先转发配置的协议参数非法'],
['code' => 'ResolverRule.PriorityForwardConfig.PriorityInvalid', 'message' => 'The priority of the priority forward configuration is invalid.', 'http_code' => 400, 'description' => '优先转发配置的优先级参数非法'],
['code' => 'ResolverRule.PriorityForwardConfig.AtLeastOneAddressWhenEnable', 'message' => 'The priority forward configuration must have at least one address.', 'http_code' => 400, 'description' => '配置启用转发规则优先转发时,需要配置至少一个HttpDNS地址。'],
['code' => 'ResolverRule.PriorityForwardConfig.ServiceAddressInvalid', 'message' => 'The service address of the priority forward configuration is invalid.', 'http_code' => 400, 'description' => '优先转发配置的云解析HttpDNS服务地址参数非法'],
['code' => 'ResolveAnalysis.Forbidden.NotSupportCurrentEnv', 'message' => 'Forbidden operation, not support current env.', 'http_code' => 400, 'description' => '环境级别和配置不相符'],
['code' => 'ResolveAnalysis.Invalid.LogProcessMode', 'message' => 'Log process mode is invalid.', 'http_code' => 400, 'description' => '无效的日志处理模式参数'],
['code' => 'ResolveAnalysis.LogDeliveryRegionMustContainAllAnalysisRegion', 'message' => 'Log delivery region must contain all analysis region.', 'http_code' => 400, 'description' => '日志转存地域必须包含全部的流量分析地域'],
['code' => 'ResolveAnalysis.Forbidden.UpdateLogDeliveryConfig', 'message' => 'Forbidden to update log delivery config.', 'http_code' => 400, 'description' => '流量分析配置变更中,请等待异步任务结束后再操作'],
['code' => 'ResolveAnalysis.Duplicate.RegionId', 'message' => 'Resolve analysis regionId is duplicate.', 'http_code' => 400, 'description' => '流量分析日志转存地域ID重复'],
['code' => 'Slslog.RemoteService.Error', 'message' => 'SLS remote service error occurred.', 'http_code' => 400, 'description' => '调用SLS服务失败,请重试'],
['code' => 'Edgedns.Cluster.FunctionModuleNotSupport', 'message' => 'Edge dns cluster function module not support.', 'http_code' => 400, 'description' => '当前集群不支持该功能,请升级集群版本'],
['code' => 'ResolveLog.NotSupportMultiNetworkParam', 'message' => 'parsing log query does not support multiple network parameters.', 'http_code' => 400, 'description' => '解析日志查询不支持多个网络参数'],
['code' => 'Statistics.UnauthorizedVpc', 'message' => 'You cannot query data within the network range for which you have no permissions.', 'http_code' => 400, 'description' => '无法查询未取得授权账号VPC的数据'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZoneInfo'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverRule'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddZone'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindZoneVpc'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MoveResourceGroup'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResolverEndpoint'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRecordRemark'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteZone'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomLineInfo'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddResolverEndpoint'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetZoneRecordStatus'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZones'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSyncEcsHostTask'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResolverEndpoint'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTags'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserVpcAuthorizations'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateZoneRemark'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRequestGraph'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverRules'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeUserServiceStatus'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCustomLine'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZoneRecords'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverAvailableZones'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddZoneRecord'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindResolverRuleVpc'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteZoneRecord'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUserVpcAuthorization'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckZoneName'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSyncEcsHostTask'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateZoneRecord'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZoneRecord'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteResolverRule'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeChangeLogs'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteUserVpcAuthorization'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddCustomLine'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomLine'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverEndpoints'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchCustomLines'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeStatisticSummary'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateResolverRule'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetProxyPattern'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeZoneVpcTree'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddResolverRule'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeResolverEndpoint'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCustomLines'],
['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeZoneDnsGroup'],
],
],
'ram' => [
'productCode' => 'PrivateZone',
'productName' => '云解析 PrivateZone',
'ramCodes' => ['pvtz'],
'ramLevel' => '资源级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'DescribeCustomLineInfo',
'description' => '查询自定义线路详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:read',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'customLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/{#lineId}'],
],
],
],
[
'apiName' => 'ChangeZoneDnsGroup',
'description' => '修改ZONE的位置区',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:ChangeZoneDnsGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'MoveResourceGroup',
'description' => '更换资源组',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:MoveResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'DescribeSyncEcsHostTask',
'description' => '获取主机名同步任务详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeSyncEcsHostTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'DescribeIntranetUserCanAnalysisVpcs',
'description' => '查看用户可分析的VPC列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'pvtz:DescribeIntranetUserCanAnalysisVpcs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListTagResources',
'description' => '查询资源标签关系列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:ListTagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddUserVpcAuthorization',
'description' => '新增跨账号VPC授权',
'operationType' => 'none',
'ramAction' => [
'action' => 'pvtz:AddUserVpcAuthorization',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateZoneRecord',
'description' => '修改解析记录',
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateZoneRecord',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'DescribeZones',
'description' => '获取 zone 列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:DescribeZones',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/*'],
],
],
],
[
'apiName' => 'DescribeResolverEndpoint',
'description' => '获取终端节点详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeResolverEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz::{#accountId}:endpoint/{#EndpointId}'],
],
],
],
[
'apiName' => 'DescribeZoneVpcTree',
'description' => '获取 Zone 列表和绑定的 VPC',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:DescribeZoneVpcTree',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/*'],
],
],
],
[
'apiName' => 'DescribeUserServiceStatus',
'description' => '查询当前用户的服务状态',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeUserServiceStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UntagResources',
'description' => '取消标记资源',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:UntagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeZoneRecords',
'description' => '查询解析记录列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeZoneRecords',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'DeleteUserVpcAuthorization',
'description' => '删除跨账号授权',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pvtz:DeleteUserVpcAuthorization',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteZoneRecord',
'description' => '删除解析记录',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pvtz:DeleteZoneRecord',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'DescribeResolverEndpoints',
'description' => '获取终端节点列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:DescribeResolverEndpoints',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz::{#accountId}:endpoint/*'],
],
],
],
[
'apiName' => 'DeleteResolverEndpoint',
'description' => '删除终端节点',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:DeleteResolverEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/{#EndpointId}'],
],
],
],
[
'apiName' => 'DescribeZoneInfo',
'description' => '获取zone详细信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeZoneInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'UpdateResolverRule',
'description' => '修改转发规则',
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateResolverRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz:*:{#accountId}:rule/{#RuleId}'],
],
],
],
[
'apiName' => 'DescribePvtzStatisticsGlobalOverview',
'description' => 'Private Zone全局解析统计概览',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribePvtzStatisticsGlobalOverview',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateResolverEndpoint',
'description' => '修改终端节点',
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateResolverEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/{#EndpointId}'],
],
],
],
[
'apiName' => 'UpdateRecordRemark',
'description' => '更新解析记录备注',
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateRecordRemark',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'DeleteCustomLine',
'description' => '删除自定义线路',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:update',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'customLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/{#lineId}'],
],
],
],
[
'apiName' => 'DescribeCustomLines',
'description' => '查询自定义线路列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:read',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'CustomLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/*'],
],
],
],
[
'apiName' => 'DescribeResolverAvailableZones',
'description' => '获取可用区域列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:DescribeResolverAvailableZones',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddResolverEndpoint',
'description' => '新增终端节点',
'operationType' => 'create',
'ramAction' => [
'action' => 'pvtz:AddResolverEndpoint',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/*'],
],
],
],
[
'apiName' => 'DeleteZone',
'description' => '删除zone',
'operationType' => 'delete',
'ramAction' => [
'action' => 'pvtz:DeleteZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'TagResources',
'description' => '标记资源',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:TagResources',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribePvtzStatisticsZoneOverview',
'description' => 'Private Zone域名解析统计概览',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribePvtzStatisticsZoneOverview',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddCustomLine',
'description' => '添加自定义线路',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:update',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeResolverRules',
'description' => '获取转发规则列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'pvtz:DescribeResolverRules',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz::{#accountId}:rule/*'],
],
],
],
[
'apiName' => 'AddZoneRecord',
'description' => '添加解析记录',
'operationType' => 'create',
'ramAction' => [
'action' => 'pvtz:AddZoneRecord',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'BindZoneVpc',
'description' => 'zone关联VPC',
'operationType' => 'none',
'ramAction' => [
'action' => 'pvtz:BindZoneVpc',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'DescribeResolverRule',
'description' => '获取转发规则详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeResolverRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz::{#accountId}:rule/{#RuleId}'],
],
],
],
[
'apiName' => 'DescribeStatisticSummary',
'description' => '获取昨日请求量概要',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeStatisticSummary',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SearchCustomLines',
'description' => '搜索自定义线路',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:read',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddResolverRule',
'description' => '新增转发规则',
'operationType' => 'create',
'ramAction' => [
'action' => 'pvtz:AddResolverRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/{#EndpointId}'],
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz:*:{#accountId}:rule/*'],
],
],
],
[
'apiName' => 'DescribeTags',
'description' => '查询已有的标签列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeTags',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeRegions',
'description' => '获取Region列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeRegions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteResolverRule',
'description' => '删除转发规则',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:DeleteResolverRule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz:*:{#accountId}:rule/{#RuleId}'],
],
],
],
[
'apiName' => 'BindResolverRuleVpc',
'description' => '转发规则关联VPC',
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:BindResolverRuleVpc',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz::{#accountId}:rule/{#RuleId}'],
],
],
],
[
'apiName' => 'DescribeChangeLogs',
'description' => '获取操作日志',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeChangeLogs',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeUserVpcAuthorizations',
'description' => '获取跨账号授权列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeUserVpcAuthorizations',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeZoneRecord',
'description' => '查询解析记录详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeZoneRecord',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'UpdateCustomLine',
'description' => '修改自定义线路',
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:update',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'customLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/{#lineId}'],
],
],
],
[
'apiName' => 'CheckZoneName',
'description' => '根据规则校验zone是否可添加',
'operationType' => '',
'ramAction' => [
'action' => 'pvtz:CheckZoneName',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateZoneRemark',
'description' => '修改zone的备注信息',
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:UpdateZoneRemark',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'SetProxyPattern',
'description' => '设置递归解析代理',
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:SetProxyPattern',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'SetZoneRecordStatus',
'description' => '设置解析记录状态',
'operationType' => 'update',
'ramAction' => [
'action' => 'pvtz:SetZoneRecordStatus',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'UpdateSyncEcsHostTask',
'description' => '更新主机名同步任务',
'operationType' => 'none',
'ramAction' => [
'action' => 'pvtz:UpdateSyncEcsHostTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
],
],
],
[
'apiName' => 'AddZone',
'description' => '添加zone',
'operationType' => 'create',
'ramAction' => [
'action' => 'pvtz:AddZone',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/*'],
],
],
],
[
'apiName' => 'DescribeRequestGraph',
'description' => '获取请求量详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'pvtz:DescribeRequestGraph',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PrivateZone', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'customLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/{#lineId}'],
['validationType' => 'always', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#ZoneId}'],
['validationType' => 'always', 'resourceType' => 'Zone', 'arn' => 'acs:pvtz::{#accountId}:zone/*'],
['validationType' => 'always', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz::{#accountId}:endpoint/{#EndpointId}'],
['validationType' => 'always', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz::{#accountId}:endpoint/*'],
['validationType' => 'always', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/{#EndpointId}'],
['validationType' => 'always', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz:*:{#accountId}:rule/{#RuleId}'],
['validationType' => 'always', 'resourceType' => 'CustomLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/*'],
['validationType' => 'always', 'resourceType' => 'Endpoint', 'arn' => 'acs:pvtz:*:{#accountId}:endpoint/*'],
['validationType' => 'always', 'resourceType' => 'customLine', 'arn' => 'acs:pvtz::{#accountId}:customLine/*'],
['validationType' => 'always', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz::{#accountId}:rule/*'],
['validationType' => 'always', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz::{#accountId}:rule/{#RuleId}'],
['validationType' => 'always', 'resourceType' => 'Rule', 'arn' => 'acs:pvtz:*:{#accountId}:rule/*'],
['validationType' => 'conditional', 'resourceType' => 'zone', 'arn' => 'acs:pvtz::{#accountId}:zone/*'],
['validationType' => 'conditional', 'resourceType' => 'zone', 'arn' => 'acs:pvtz::{#accountId}:zone/{#zoneId}'],
],
],
];