'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Alidns',
'version' => '2015-01-09',
],
'directories' => [
[
'id' => 404240,
'title' => 'RSP',
'type' => 'directory',
'children' => [
'UpdateRspDomainServerProhibitStatusForGatewayOte',
'RemoveRspDomainServerHoldStatusForGatewayOte',
'AddRspDomainServerHoldStatusForGatewayOte',
'UpdateRspDomainServerProhibitStatusForGateway',
'RemoveRspDomainServerHoldStatusForGateway',
'AddRspDomainServerHoldStatusForGateway',
],
],
[
'id' => 404247,
'title' => '云解析实例',
'type' => 'directory',
'children' => [
'DescribeDnsProductInstance',
'DescribeDnsProductInstances',
'DescribeInstanceDomains',
],
],
[
'id' => 404251,
'title' => '域名',
'type' => 'directory',
'children' => [
'AddDomain',
'DeleteDomain',
'DescribeDomains',
'DescribeDomainInfo',
'AddDomainBackup',
'ChangeDomainOfDnsProduct',
'ModifyHichinaDomainDNS',
'UpdateDomainRemark',
'GetMainDomainName',
'DescribeDomainNs',
'SetDomainDnssecStatus',
'DescribeDomainDnssecInfo',
'BindInstanceDomains',
'UnbindInstanceDomains',
'OperateBatchDomain',
[
'id' => 404267,
'title' => '域名分组',
'type' => 'directory',
'children' => [
'AddDomainGroup',
'DescribeDomainGroups',
'DeleteDomainGroup',
'UpdateDomainGroup',
'ChangeDomainGroup',
],
],
'TransferDomain',
'RetrieveDomain',
'DescribeTransferDomains',
'DescribeDomainStatistics',
'DescribeDomainStatisticsSummary',
'DescribeRecordStatistics',
'DescribeRecordStatisticsSummary',
'DescribeDNSSLBSubDomains',
'DescribeDomainLogs',
],
],
[
'id' => 404282,
'title' => '解析记录',
'type' => 'directory',
'children' => [
'AddDomainRecord',
'DeleteDomainRecord',
'DeleteSubDomainRecords',
'UpdateDomainRecord',
'UpdateDomainRecordRemark',
'SetDomainRecordStatus',
'DescribeDomainRecordInfo',
'DescribeDomainRecords',
'DescribeRecordLogs',
'DescribeSubDomainRecords',
'GetTxtRecordForVerify',
],
],
[
'id' => 404294,
'title' => '自定义线路',
'type' => 'directory',
'children' => [
'AddCustomLine',
'DeleteCustomLines',
'UpdateCustomLine',
'DescribeCustomLine',
'DescribeCustomLines',
'DescribeSupportLines',
],
],
[
'id' => 404301,
'title' => '权重',
'type' => 'directory',
'children' => [
'SetDNSSLBStatus',
'UpdateDNSSLBWeight',
],
],
[
'id' => 404304,
'title' => '批量处理',
'type' => 'directory',
'children' => [
'DescribeBatchResultCount',
'DescribeBatchResultDetail',
],
],
[
'id' => 404307,
'title' => '标签与资源组',
'type' => 'directory',
'children' => [
'DescribeTags',
'ListTagResources',
'TagResources',
'UntagResources',
'MoveDomainResourceGroup',
],
],
[
'id' => 404313,
'title' => '权威代理域名',
'type' => 'directory',
'children' => [
'AddDnsCacheDomain',
'UpdateDnsCacheDomain',
'UpdateDnsCacheDomainRemark',
'DeleteDnsCacheDomain',
'DescribeDnsCacheDomains',
],
],
[
'id' => 404319,
'title' => 'GTM3.0',
'type' => 'directory',
'children' => [
[
'id' => 404320,
'title' => 'GTM Instances',
'type' => 'directory',
'children' => [
'CreateCloudGtmInstanceConfig',
'UpdateCloudGtmInstanceName',
'SetCloudGtmInstanceConfigLogSwitch',
'DescribeCloudGtmInstanceConfigFullInfo',
'ListCloudGtmInstanceConfigs',
'DeleteCloudGtmInstanceConfig',
'UpdateCloudGtmInstanceConfigBasic',
'UpdateCloudGtmInstanceConfigLbStrategy',
'UpdateCloudGtmInstanceConfigEnableStatus',
'UpdateCloudGtmInstanceConfigRemark',
'ListCloudGtmInstances',
'SearchCloudGtmInstances',
'SearchCloudGtmInstanceConfigs',
'DescribeCloudGtmSummary',
],
],
[
'id' => 404335,
'title' => 'GTM Address',
'type' => 'directory',
'children' => [
'CreateCloudGtmAddress',
'UpdateCloudGtmAddress',
'DescribeCloudGtmAddress',
'DeleteCloudGtmAddress',
'UpdateCloudGtmAddressRemark',
'ListCloudGtmAddresses',
'SearchCloudGtmAddresses',
'DescribeCloudGtmAddressReference',
'UpdateCloudGtmAddressEnableStatus',
'UpdateCloudGtmAddressManualAvailableStatus',
],
],
[
'id' => 404346,
'title' => 'GTM AddressPool',
'type' => 'directory',
'children' => [
'CreateCloudGtmAddressPool',
'ListCloudGtmAddressPools',
'DescribeCloudGtmAddressPool',
'DeleteCloudGtmAddressPool',
'SearchCloudGtmAddressPools',
'ReplaceCloudGtmInstanceConfigAddressPool',
'UpdateCloudGtmAddressPoolEnableStatus',
'UpdateCloudGtmAddressPoolRemark',
'UpdateCloudGtmAddressPoolLbStrategy',
'UpdateCloudGtmAddressPoolBasicConfig',
'ReplaceCloudGtmAddressPoolAddress',
'DescribeCloudGtmAddressPoolReference',
],
],
[
'id' => 404359,
'title' => 'GTM Monitor',
'type' => 'directory',
'children' => [
'SearchCloudGtmMonitorTemplates',
'CreateCloudGtmMonitorTemplate',
'DeleteCloudGtmMonitorTemplate',
'UpdateCloudGtmMonitorTemplate',
'ListCloudGtmMonitorTemplates',
'DescribeCloudGtmMonitorTemplate',
'UpdateCloudGtmMonitorTemplateRemark',
'ListCloudGtmMonitorNodes',
],
],
'DescribeCloudGtmSystemLines',
'ListCloudGtmAlertLogs',
'DescribeCloudGtmInstanceConfigAlert',
'UpdateCloudGtmGlobalAlert',
'DescribeCloudGtmGlobalAlert',
'UpdateCloudGtmInstanceConfigAlert',
'ListCloudGtmAvailableAlertGroups',
],
],
[
'id' => 404375,
'title' => 'GTM',
'type' => 'directory',
'children' => [
[
'id' => 404376,
'title' => 'GTM 实例',
'type' => 'directory',
'children' => [
'SetGtmAccessMode',
'UpdateDnsGtmInstanceGlobalConfig',
'UpdateGtmInstanceGlobalConfig',
'UpdateDnsGtmAccessStrategy',
'DescribeDnsGtmAddrAttributeInfo',
'DescribeDnsGtmAvailableAlertGroup',
'DescribeDnsGtmInstance',
'DescribeGtmInstance',
'DescribeDnsGtmInstances',
'DescribeGtmInstances',
'DescribeDnsGtmInstanceStatus',
'DescribeGtmInstanceStatus',
'DescribeDnsGtmLogs',
'DescribeGtmAvailableAlertGroup',
'DescribeGtmLogs',
'DescribeGtmInstanceSystemCname',
'DescribeDnsGtmInstanceSystemCname',
'CopyGtmConfig',
'MoveGtmResourceGroup',
'ValidateDnsGtmCnameRrCanUse',
],
],
[
'id' => 404397,
'title' => '地址池',
'type' => 'directory',
'children' => [
'AddGtmAddressPool',
'AddDnsGtmAddressPool',
'DeleteDnsGtmAddressPool',
'DeleteGtmAddressPool',
'UpdateDnsGtmAddressPool',
'UpdateGtmAddressPool',
'DescribeDnsGtmInstanceAddressPool',
'DescribeDnsGtmInstanceAddressPools',
'DescribeDnsGtmAddressPoolAvailableConfig',
'DescribeGtmInstanceAddressPool',
'DescribeGtmInstanceAddressPools',
],
],
[
'id' => 404409,
'title' => '健康检查',
'type' => 'directory',
'children' => [
'AddDnsGtmMonitor',
'AddGtmMonitor',
'UpdateDnsGtmMonitor',
'UpdateGtmMonitor',
'SetDnsGtmMonitorStatus',
'SetGtmMonitorStatus',
'DescribeGtmMonitorAvailableConfig',
'DescribeGtmMonitorConfig',
'DescribeDnsGtmMonitorAvailableConfig',
'DescribeDnsGtmMonitorConfig',
],
],
[
'id' => 404420,
'title' => '访问策略',
'type' => 'directory',
'children' => [
'AddDnsGtmAccessStrategy',
'AddGtmAccessStrategy',
'DeleteDnsGtmAccessStrategy',
'DeleteGtmAccessStrategy',
'UpdateGtmAccessStrategy',
'SetDnsGtmAccessMode',
'DescribeDnsGtmAccessStrategies',
'DescribeDnsGtmAccessStrategy',
'DescribeDnsGtmAccessStrategyAvailableConfig',
'DescribeGtmAccessStrategies',
'DescribeGtmAccessStrategy',
'DescribeGtmAccessStrategyAvailableConfig',
'SwitchDnsGtmInstanceStrategyMode',
],
],
[
'id' => 404434,
'title' => '容灾',
'type' => 'directory',
'children' => [
'AddGtmRecoveryPlan',
'DeleteGtmRecoveryPlan',
'UpdateGtmRecoveryPlan',
'DescribeGtmRecoveryPlan',
'DescribeGtmRecoveryPlanAvailableConfig',
'DescribeGtmRecoveryPlans',
'ExecuteGtmRecoveryPlan',
'PreviewGtmRecoveryPlan',
'RollbackGtmRecoveryPlan',
],
],
],
],
[
'id' => 404444,
'title' => 'HTTPDNS',
'type' => 'directory',
'children' => [
'AddRecursionZone',
'DescribeRecursionZone',
'ListRecursionZones',
'DeleteRecursionZone',
'SearchRecursionZones',
'UpdateRecursionZoneEffectiveScope',
'UpdateRecursionZoneRemark',
'UpdateRecursionZoneProxyPattern',
'AddRecursionRecord',
'DescribeRecursionRecord',
'UpdateRecursionRecord',
'ListRecursionRecords',
'DeleteRecursionRecord',
'SearchRecursionRecords',
'UpdateRecursionRecordEnableStatus',
'UpdateRecursionRecordWeight',
'UpdateRecursionRecordWeightEnableStatus',
'UpdateRecursionRecordRemark',
],
],
[
'id' => 404463,
'title' => 'DoH 域名',
'type' => 'directory',
'children' => [
'DescribeDohAccountStatistics',
'DescribeDohDomainStatistics',
'DescribeDohDomainStatisticsSummary',
'DescribeDohSubDomainStatistics',
'DescribeDohSubDomainStatisticsSummary',
'DescribeDohUserInfo',
],
],
[
'id' => 404470,
'title' => 'PdnsAppKey',
'type' => 'directory',
'children' => [
'CreatePdnsAppKey',
'RemovePdnsAppKey',
'DescribePdnsAppKey',
'DescribePdnsAppKeys',
'UpdateAppKeyState',
],
],
[
'id' => 404476,
'title' => '其他',
'type' => 'directory',
'children' => [
'CreatePdnsUdpIpSegment',
'ValidatePdnsUdpIpSegment',
'DescribePdnsUdpIpSegments',
'RemovePdnsUdpIpSegment',
'DescribePdnsThreatStatistics',
'DescribePdnsUserInfo',
'DescribePdnsRequestStatistic',
'DescribePdnsThreatLogs',
'DescribePdnsRequestStatistics',
'DescribePdnsOperateLogs',
'ResumePdnsService',
'DescribePdnsAccountSummary',
'PausePdnsService',
'DescribePdnsThreatStatistic',
'UpdateIspFlushCacheInstanceConfig',
'SubmitIspFlushCacheTask',
'DescribeIspFlushCacheRemainQuota',
'DescribeIspFlushCacheInstances',
'DescribeIspFlushCacheTask',
'DescribeIspFlushCacheTasks',
'DescribeRecordResolveStatisticsSummary',
'DescribeDomainResolveStatisticsSummary',
'DescribeInternetDnsLogs',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'UpdateRspDomainServerProhibitStatusForGatewayOte' => [
'summary' => '用于更新特定域名的状态信息。',
'description' => '本接口用于更新域名的服务端状态',
'path' => '',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'title' => '幂等参数',
'description' => '幂等参数',
'type' => 'string',
'required' => true,
'example' => 'qwoefasdf',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'AddStatusList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '添加域名状态集合',
'type' => 'array',
'items' => [
'description' => '添加域名状态集合',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '域名状态',
'type' => 'string',
'required' => false,
'example' => 'serverDeleteProhibited',
'enum' => [
'serverDeleteProhibited',
'serverRenewProhibited',
'serverTransferProhibited',
'serverUpdateProhibited',
],
],
'StatusMsg' => [
'description' => '状态描述信息',
'type' => 'string',
'required' => false,
'example' => '实名认证未通过,增加serverUpdateProhibited状态',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DeleteStatusList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '删除域名状态集合',
'type' => 'array',
'items' => [
'description' => '删除域名状态集合',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '域名状态',
'type' => 'string',
'required' => false,
'example' => 'serverDeleteProhibited',
'enum' => [
'serverDeleteProhibited',
'serverRenewProhibited',
'serverTransferProhibited',
'serverUpdateProhibited',
],
],
'StatusMsg' => [
'description' => '状态描述信息',
'type' => 'string',
'required' => false,
'example' => '实名认证通过,删除serverUpdateProhibited状态',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'description' => '请求成功',
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求唯一标识'."\n",
'description' => '请求唯一标识'."\n",
'type' => 'string',
'example' => '0629502C-6224-5DC9-A8ED-2ED73A2E3931',
],
'Success' => [
'title' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'description' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'type' => 'boolean',
'example' => 'true',
],
'RecoverableError' => [
'title' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'description' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'StatusList' => [
'description' => '任务状态信息',
'type' => 'array',
'items' => [
'description' => '任务状态信息',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'Status' => [
'description' => '当前域名状态。',
'type' => 'string',
'example' => 'serverUpdateProhibited',
],
'StatusMsg' => [
'description' => '域名状态Msg',
'type' => 'string',
'example' => '实名认证未通过,增加serverUpdateProhibited状态',
],
],
],
],
],
],
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '尝试执行的未授权操作。',
'type' => 'string',
'example' => 'UpdateRspDomainServerProhibitStatusForGatewayOte',
],
'AuthPrincipalDisplayName' => [
'description' => '授权主体显示名称。',
'type' => 'string',
'example' => '2015555733387XXXX',
],
'AuthPrincipalOwnerId' => [
'description' => '授权主体所有者ID。',
'type' => 'string',
'example' => '10469733312XXX',
],
'AuthPrincipalType' => [
'description' => '身份类型',
'type' => 'string',
'example' => 'SubUser',
],
'EncodedDiagnosticMessage' => [
'description' => '加密后的完整诊断信息。',
'type' => 'string',
'example' => 'AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==',
],
'NoPermissionType' => [
'description' => '导致鉴权失败的原因。具体取值为:'."\n"
.'- ExplicitDeny:显示拒绝'."\n"
.'- ImplicitDeny:隐式拒绝',
'type' => 'string',
'example' => 'ImplicitDeny',
],
'PolicyType' => [
'description' => '策略类型。',
'type' => 'string',
'example' => 'DlpSend',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Alirs.Operator.NotAuthorized',
'errorMessage' => 'The operator does not belong to the cloud account.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0629502C-6224-5DC9-A8ED-2ED73A2E3931\\",\\n \\"Success\\": true,\\n \\"RecoverableError\\": true,\\n \\"Data\\": {\\n \\"DomainName\\": \\"example.com\\",\\n \\"StatusList\\": [\\n {\\n \\"DomainName\\": \\"example.com\\",\\n \\"Status\\": \\"serverUpdateProhibited\\",\\n \\"StatusMsg\\": \\"实名认证未通过,增加serverUpdateProhibited状态\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"UpdateRspDomainServerProhibitStatusForGatewayOte\\",\\n \\"AuthPrincipalDisplayName\\": \\"2015555733387XXXX\\",\\n \\"AuthPrincipalOwnerId\\": \\"10469733312XXX\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"DlpSend\\"\\n }\\n}","type":"json"}]',
'title' => '修改域名ServerProhibit状态',
],
'RemoveRspDomainServerHoldStatusForGatewayOte' => [
'summary' => '用于删除指定域名的serverHold状态信息。',
'description' => '## 请求说明'."\n"
.'- 本接口用于删除指定域名的serverHold状态信息。',
'path' => '',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'title' => '幂等参数',
'description' => '幂等参数',
'type' => 'string',
'required' => true,
'example' => 'qwoefasdf',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'StatusMsg',
'in' => 'query',
'schema' => [
'description' => '状态描述信息',
'type' => 'string',
'required' => false,
'example' => '实名认证通过,解除serverHold状态',
],
],
],
'responses' => [
200 => [
'description' => '请求成功',
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求唯一标识'."\n",
'description' => '请求唯一标识'."\n",
'type' => 'string',
'example' => '0629502C-6224-5DC9-A8ED-2ED73A2E3931',
],
'Success' => [
'title' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'description' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'type' => 'boolean',
'example' => 'true',
],
'RecoverableError' => [
'title' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'description' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
],
],
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '尝试执行的未授权操作。',
'type' => 'string',
'example' => 'RemoveRspDomainServerHoldStatusForGatewayOte',
],
'AuthPrincipalDisplayName' => [
'description' => '授权主体显示名称。',
'type' => 'string',
'example' => '2015555733387XXXX',
],
'AuthPrincipalOwnerId' => [
'description' => '授权主体所有者ID。',
'type' => 'string',
'example' => '10469733312XXX',
],
'AuthPrincipalType' => [
'description' => '身份类型',
'type' => 'string',
'example' => 'SubUser',
],
'EncodedDiagnosticMessage' => [
'description' => '加密后的完整诊断信息。',
'type' => 'string',
'example' => 'AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==',
],
'NoPermissionType' => [
'description' => '导致鉴权失败的原因。具体取值为:'."\n"
.'- ExplicitDeny:显示拒绝'."\n"
.'- ImplicitDeny:隐式拒绝',
'type' => 'string',
'example' => 'ImplicitDeny',
],
'PolicyType' => [
'description' => '策略类型。',
'type' => 'string',
'example' => 'DlpSend',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0629502C-6224-5DC9-A8ED-2ED73A2E3931\\",\\n \\"Success\\": true,\\n \\"RecoverableError\\": true,\\n \\"Data\\": {\\n \\"DomainName\\": \\"example.com\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"RemoveRspDomainServerHoldStatusForGatewayOte\\",\\n \\"AuthPrincipalDisplayName\\": \\"2015555733387XXXX\\",\\n \\"AuthPrincipalOwnerId\\": \\"10469733312XXX\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"DlpSend\\"\\n }\\n}","type":"json"}]',
'title' => '移除域名serverHold状态',
],
'AddRspDomainServerHoldStatusForGatewayOte' => [
'summary' => '用于添加特定域名的serverHold状态信息。',
'description' => '## 请求说明'."\n"
.'- 本接口用于添加指定域名的serverHold状态信息。',
'path' => '',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'title' => '幂等参数',
'description' => '幂等参数',
'type' => 'string',
'required' => true,
'example' => 'qwoefasdf',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称',
'type' => 'string',
'required' => true,
'example' => 'dns-example.top',
],
],
[
'name' => 'StatusMsg',
'in' => 'query',
'schema' => [
'description' => '状态描述信息',
'type' => 'string',
'required' => true,
'example' => '实名认证通过,解除serverHold状态',
],
],
],
'responses' => [
200 => [
'description' => '请求成功',
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求唯一标识'."\n",
'description' => '请求唯一标识'."\n",
'type' => 'string',
'example' => '0629502C-6224-5DC9-A8ED-2ED73A2E3931',
],
'Success' => [
'title' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'description' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'type' => 'boolean',
'example' => 'true',
],
'RecoverableError' => [
'title' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'description' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
],
],
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '尝试执行的未授权操作。',
'type' => 'string',
'example' => 'AddRspDomainServerHoldStatusForGatewayOte',
],
'AuthPrincipalDisplayName' => [
'description' => '授权主体显示名称。',
'type' => 'string',
'example' => '2015555733387XXXX',
],
'AuthPrincipalOwnerId' => [
'description' => '授权主体所有者ID。',
'type' => 'string',
'example' => '10469733312XXX',
],
'AuthPrincipalType' => [
'description' => '身份类型',
'type' => 'string',
'example' => 'SubUser',
],
'EncodedDiagnosticMessage' => [
'description' => '加密后的完整诊断信息。',
'type' => 'string',
'example' => 'AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==',
],
'NoPermissionType' => [
'description' => '导致鉴权失败的原因。具体取值为:'."\n"
.'- ExplicitDeny:显示拒绝'."\n"
.'- ImplicitDeny:隐式拒绝',
'type' => 'string',
'example' => 'ImplicitDeny',
],
'PolicyType' => [
'description' => '策略类型。',
'type' => 'string',
'example' => 'DlpSend',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0629502C-6224-5DC9-A8ED-2ED73A2E3931\\",\\n \\"Success\\": true,\\n \\"RecoverableError\\": true,\\n \\"Data\\": {\\n \\"DomainName\\": \\"example.com\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"AddRspDomainServerHoldStatusForGatewayOte\\",\\n \\"AuthPrincipalDisplayName\\": \\"2015555733387XXXX\\",\\n \\"AuthPrincipalOwnerId\\": \\"10469733312XXX\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"DlpSend\\"\\n }\\n}","type":"json"}]',
'title' => '添加ServerHold状态',
],
'UpdateRspDomainServerProhibitStatusForGateway' => [
'summary' => '用于更新特定域名的状态信息。',
'description' => '## 请求说明'."\n"
.'- 本接口用于更新域名的服务端状态',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'title' => '幂等参数',
'description' => '幂等参数',
'type' => 'string',
'required' => true,
'example' => 'asdf',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '需要修改serverHold状态的域名',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'AddStatusList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '添加域名状态集合',
'type' => 'array',
'items' => [
'description' => '添加域名状态集合',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '域名状态',
'type' => 'string',
'required' => false,
'example' => 'serverDeleteProhibited',
'enum' => [
'serverDeleteProhibited',
'serverRenewProhibited',
'serverTransferProhibited',
'serverUpdateProhibited',
],
],
'StatusMsg' => [
'description' => '状态描述信息',
'type' => 'string',
'required' => false,
'example' => '实名认证未通过,增加serverUpdateProhibited状态',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'DeleteStatusList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '删除域名状态集合',
'type' => 'array',
'items' => [
'description' => '删除域名状态集合',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '域名状态',
'type' => 'string',
'required' => false,
'example' => 'serverDeleteProhibited',
'enum' => [
'serverDeleteProhibited',
'serverRenewProhibited',
'serverTransferProhibited',
'serverUpdateProhibited',
],
],
'StatusMsg' => [
'description' => '状态描述信息',
'type' => 'string',
'required' => false,
'example' => '实名认证通过,删除serverUpdateProhibited状态',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'description' => '请求成功',
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求唯一标识'."\n",
'description' => '请求唯一标识'."\n",
'type' => 'string',
'example' => '0629502C-6224-5DC9-A8ED-2ED73A2E3931',
],
'Success' => [
'title' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'description' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'type' => 'boolean',
'example' => 'true',
],
'RecoverableError' => [
'title' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'description' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'StatusList' => [
'description' => '任务状态信息',
'type' => 'array',
'items' => [
'description' => '任务状态信息',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'uptp.test.abchina.com.cn',
],
'Status' => [
'description' => '当前域名状态。',
'type' => 'string',
'example' => 'serverUpdateProhibited',
],
'StatusMsg' => [
'description' => '域名状态Msg',
'type' => 'string',
'example' => '实名认证未通过,增加serverUpdateProhibited状态',
],
],
],
],
],
],
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '尝试执行的未授权操作。',
'type' => 'string',
'example' => 'UpdateRspDomainServerProhibitStatusForGateway',
],
'AuthPrincipalDisplayName' => [
'description' => '授权主体显示名称。',
'type' => 'string',
'example' => '2015555733387XXXX',
],
'AuthPrincipalOwnerId' => [
'description' => '授权主体所有者ID。',
'type' => 'string',
'example' => '10469733312XXX',
],
'AuthPrincipalType' => [
'description' => '身份类型',
'type' => 'string',
'example' => 'SubUser',
],
'EncodedDiagnosticMessage' => [
'description' => '加密后的完整诊断信息。',
'type' => 'string',
'example' => 'AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==',
],
'NoPermissionType' => [
'description' => '导致鉴权失败的原因。具体取值为:'."\n"
.'- ExplicitDeny:显示拒绝'."\n"
.'- ImplicitDeny:隐式拒绝',
'type' => 'string',
'example' => 'ImplicitDeny',
],
'PolicyType' => [
'description' => '策略类型。',
'type' => 'string',
'example' => 'DlpSend',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Alirs.Operator.NotAuthorized',
'errorMessage' => 'The operator does not belong to the cloud account.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0629502C-6224-5DC9-A8ED-2ED73A2E3931\\",\\n \\"Success\\": true,\\n \\"RecoverableError\\": true,\\n \\"Data\\": {\\n \\"DomainName\\": \\"example.com\\",\\n \\"StatusList\\": [\\n {\\n \\"DomainName\\": \\"uptp.test.abchina.com.cn\\",\\n \\"Status\\": \\"serverUpdateProhibited\\",\\n \\"StatusMsg\\": \\"实名认证未通过,增加serverUpdateProhibited状态\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"UpdateRspDomainServerProhibitStatusForGateway\\",\\n \\"AuthPrincipalDisplayName\\": \\"2015555733387XXXX\\",\\n \\"AuthPrincipalOwnerId\\": \\"10469733312XXX\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"DlpSend\\"\\n }\\n}","type":"json"}]',
'title' => '修改域名ServerProhibit状态',
],
'RemoveRspDomainServerHoldStatusForGateway' => [
'summary' => '用于删除特定域名的serverHold状态信息。',
'description' => '## 请求说明'."\n"
.'- 本接口用于移除指定域名的serverHold状态。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'title' => '幂等参数',
'description' => '幂等参数',
'type' => 'string',
'required' => true,
'example' => 'asdf',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'StatusMsg',
'in' => 'query',
'schema' => [
'description' => '状态描述信息',
'type' => 'string',
'required' => false,
'example' => '实名认证通过,解除serverHold状态',
],
],
],
'responses' => [
200 => [
'description' => '请求成功',
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求唯一标识'."\n",
'description' => '请求唯一标识'."\n",
'type' => 'string',
'example' => '0629502C-6224-5DC9-A8ED-2ED73A2E3931',
],
'Success' => [
'title' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'description' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'type' => 'boolean',
'example' => 'true',
],
'RecoverableError' => [
'title' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'description' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'ServerHoldStatus' => [
'description' => '域名serverHold状态',
'type' => 'string',
'example' => 'enable',
],
],
],
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '尝试执行的未授权操作。',
'type' => 'string',
'example' => 'RemoveRspDomainServerHoldStatusForGateway',
],
'AuthPrincipalDisplayName' => [
'description' => '授权主体显示名称。',
'type' => 'string',
'example' => '2015555733387XXXX',
],
'AuthPrincipalOwnerId' => [
'description' => '授权主体所有者ID。',
'type' => 'string',
'example' => '10469733312XXX',
],
'AuthPrincipalType' => [
'description' => '身份类型',
'type' => 'string',
'example' => 'SubUser',
],
'EncodedDiagnosticMessage' => [
'description' => '加密后的完整诊断信息。',
'type' => 'string',
'example' => 'AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==',
],
'NoPermissionType' => [
'description' => '导致鉴权失败的原因。具体取值为:'."\n"
.'- ExplicitDeny:显示拒绝'."\n"
.'- ImplicitDeny:隐式拒绝',
'type' => 'string',
'example' => 'ImplicitDeny',
],
'PolicyType' => [
'description' => '策略类型。',
'type' => 'string',
'example' => 'DlpSend',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0629502C-6224-5DC9-A8ED-2ED73A2E3931\\",\\n \\"Success\\": true,\\n \\"RecoverableError\\": true,\\n \\"Data\\": {\\n \\"DomainName\\": \\"example.com\\",\\n \\"ServerHoldStatus\\": \\"enable\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"RemoveRspDomainServerHoldStatusForGateway\\",\\n \\"AuthPrincipalDisplayName\\": \\"2015555733387XXXX\\",\\n \\"AuthPrincipalOwnerId\\": \\"10469733312XXX\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"DlpSend\\"\\n }\\n}","type":"json"}]',
'title' => '移除域名serverHold状态',
],
'AddRspDomainServerHoldStatusForGateway' => [
'summary' => '用于添加特定域名的serverHold状态信息。',
'description' => '## 请求说明'."\n"
.'- 本接口用于添加指定域名的serverHold属性。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'title' => '幂等参数',
'description' => '幂等参数',
'type' => 'string',
'required' => true,
'example' => 'token123',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称',
'type' => 'string',
'required' => true,
'example' => 'dns-example.top',
],
],
[
'name' => 'StatusMsg',
'in' => 'query',
'schema' => [
'description' => '状态描述信息',
'type' => 'string',
'required' => true,
'example' => '实名认证通过,解除serverHold状态',
],
],
],
'responses' => [
200 => [
'description' => '请求成功',
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求唯一标识'."\n",
'description' => '请求唯一标识'."\n",
'type' => 'string',
'example' => '0629502C-XXXX-5DC9-XXXX-2ED73A2E3931',
],
'Success' => [
'title' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'description' => '请求是否成功,`true`:成功,`false`:失败'."\n",
'type' => 'boolean',
'example' => 'true',
],
'RecoverableError' => [
'title' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'description' => '请求失败能否重试,`true`:可重试,`false`:不可重试'."\n",
'type' => 'boolean',
'example' => 'true',
],
'Data' => [
'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
],
],
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '尝试执行的未授权操作。',
'type' => 'string',
'example' => 'AddRspDomainServerHoldStatusForGateway',
],
'AuthPrincipalDisplayName' => [
'description' => '授权主体显示名称。',
'type' => 'string',
'example' => '2015555733387XXXX',
],
'AuthPrincipalOwnerId' => [
'description' => '授权主体所有者ID。',
'type' => 'string',
'example' => '1046973331XXXX',
],
'AuthPrincipalType' => [
'description' => '身份类型',
'type' => 'string',
'example' => 'SubUser',
],
'EncodedDiagnosticMessage' => [
'description' => '加密后的完整诊断信息。',
'type' => 'string',
'example' => 'AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==',
],
'NoPermissionType' => [
'description' => '导致鉴权失败的原因。具体取值为:'."\n"
.'- ExplicitDeny:显示拒绝'."\n"
.'- ImplicitDeny:隐式拒绝',
'type' => 'string',
'example' => 'ImplicitDeny',
],
'PolicyType' => [
'description' => '策略类型。',
'type' => 'string',
'example' => 'DlpSend',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0629502C-XXXX-5DC9-XXXX-2ED73A2E3931\\",\\n \\"Success\\": true,\\n \\"RecoverableError\\": true,\\n \\"Data\\": {\\n \\"DomainName\\": \\"example.com\\"\\n },\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"AddRspDomainServerHoldStatusForGateway\\",\\n \\"AuthPrincipalDisplayName\\": \\"2015555733387XXXX\\",\\n \\"AuthPrincipalOwnerId\\": \\"1046973331XXXX\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==\\",\\n \\"NoPermissionType\\": \\"ImplicitDeny\\",\\n \\"PolicyType\\": \\"DlpSend\\"\\n }\\n}","type":"json"}]',
'title' => '添加域名serverHold状态',
],
'DescribeDnsProductInstance' => [
'summary' => '根据实例ID获取云解析收费版本产品实例的详情信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsT5OPHE',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.0',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。可通过调用[DescribeDomainInfo](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomaininfo?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomainInfo](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomaininfo?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'i-8fxxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MonitorNodeCount' => [
'description' => '监控节点个数。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'InBlackHole' => [
'description' => '域名是否处于黑洞状态。'."\n"
."\n"
.'- true:处于黑洞状态'."\n"
."\n"
.'- false:非黑洞状态',
'type' => 'boolean',
'example' => 'false',
],
'BindDomainCount' => [
'description' => '适用于个人版、企业旗舰版用户调用,指付费版DNS实例可以绑定的域名个数。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'RegionLines' => [
'description' => '是否是地域线路。'."\n"
."\n"
.'- true:地域线路'."\n"
."\n"
.'- false:非地域线路',
'type' => 'boolean',
'example' => 'true',
],
'BindCount' => [
'description' => '适用于定制版用户调用,指付费版DNS实例可支持更换域名次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'EndTime' => [
'description' => '实例到期时间。',
'type' => 'string',
'example' => '2015-12-12T09:23Z',
],
'StartTimestamp' => [
'description' => '实例购买时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1474335170000',
],
'ISPLines' => [
'description' => '运营商解析请求来源线路列表。'."\n"
."\n"
.'- 中国电信'."\n"
.'- 中国移动'."\n"
.'- 中国联通'."\n"
.'- 中国教育网'."\n"
.'- 中国广电网'."\n"
.'- 中国鹏博士',
'type' => 'string',
'example' => '中国电信',
],
'EndTimestamp' => [
'description' => '实例到期时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1474335170000',
],
'DnsServers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsServer' => [
'description' => '域名当前设置的DNS服务器列表。',
'type' => 'array',
'items' => [
'description' => 'DNS服务器详情。',
'type' => 'string',
'example' => '{"DnsServer": ["vip1.alidns.com","vip2.alidns.com"]}',
],
],
],
],
'DDosDefendQuery' => [
'description' => '适用于定制版用户调用,DNS防护QPS(万qps)',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'DnsSecurity' => [
'description' => 'DNS安全。取值:'."\n"
.'- no:不需要'."\n"
.'- basic:dns攻击基础防御'."\n"
.'- advanced:dns攻击全力防御',
'type' => 'string',
'example' => 'advanced',
],
'DomainType' => [
'description' => '实例类型:'."\n"
.'- PUBLIC:权威托管域名实例。'."\n"
.'- CACHE:权威代理域名实例。',
'type' => 'string',
'example' => 'PUBLIC',
],
'URLForwardCount' => [
'description' => 'URL转发数量(个)。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'TTLMinValue' => [
'description' => '最小TTL值(秒)。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'PaymentType' => [
'description' => '付费类型。',
'type' => 'string',
'example' => 'Subscription',
],
'VersionName' => [
'description' => '云解析产品名称。',
'type' => 'string',
'example' => '企业旗舰版',
],
'OverseaLine' => [
'description' => '海外线路。',
'type' => 'string',
'example' => '海外大洲',
],
'ISPRegionLines' => [
'description' => '运营商解析请求来源线路列表。'."\n"
.'- 电信(省份)'."\n"
.'- 移动(省份)'."\n"
.'- 联通(省份)'."\n"
.'- 教育网(省份)',
'type' => 'string',
'example' => '电信_浙江',
],
'Gslb' => [
'description' => '是否允许GSLB。'."\n"
."\n"
.'- true:允许'."\n"
."\n"
.'- false:不允许',
'type' => 'boolean',
'example' => 'true',
],
'BindUsedCount' => [
'description' => '适用于定制版用户调用,指付费版DNS实例已使用的更换域名次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-xxxxxxx',
],
'DnsSLBCount' => [
'description' => '负载均衡(单域名、单线路的IP地址容量)。',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'InstanceId' => [
'description' => '云解析产品ID。',
'type' => 'string',
'example' => 'i-8fxxx',
],
'MonitorTaskCount' => [
'description' => '监控任务数(个)。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'StartTime' => [
'description' => '购买时间。',
'type' => 'string',
'example' => '2015-12-12T09:23Z',
],
'DDosDefendFlow' => [
'description' => 'DNS防护流量(单位:G)。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'MonitorFrequency' => [
'description' => '监控频率(单位:分钟)。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'SearchEngineLines' => [
'description' => '搜索引擎解析请求来源线路列表。'."\n"
.'- 谷歌'."\n"
.'- 百度'."\n"
.'- 必应'."\n"
.'- 有道',
'type' => 'string',
'example' => '谷歌',
],
'BindDomainUsedCount' => [
'description' => '适用于个人版、企业旗舰版用户调用,指付费版DNS实例已绑定使用的域名个数。',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'VersionCode' => [
'description' => '云解析产品code。',
'type' => 'string',
'example' => 'version1',
],
'OverseaDDosDefendFlow' => [
'description' => '海外DNS防护(单位:G)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'InClean' => [
'description' => '域名是否处于清洗状态。'."\n"
.'- true:处于清洗状态'."\n"
.'- false:不处于清洗状态',
'type' => 'boolean',
'example' => 'false',
],
'SubDomainLevel' => [
'description' => '子域名级别(个)。',
'type' => 'integer',
'format' => 'int64',
'example' => '6',
],
'Domain' => [
'description' => '绑定的域名。'."\n"
."\n"
.'如果为空,则表示未绑定域名。',
'type' => 'string',
'example' => 'example.com',
],
'AutoRenewal' => [
'description' => '实例自动续费状态。'."\n"
."\n"
.'- true:自动续费'."\n"
."\n"
.'- false:非自动续费',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MonitorNodeCount\\": 5,\\n \\"InBlackHole\\": false,\\n \\"BindDomainCount\\": 5,\\n \\"RegionLines\\": true,\\n \\"BindCount\\": 3,\\n \\"EndTime\\": \\"2015-12-12T09:23Z\\",\\n \\"StartTimestamp\\": 1474335170000,\\n \\"ISPLines\\": \\"中国电信\\",\\n \\"EndTimestamp\\": 1474335170000,\\n \\"DnsServers\\": {\\n \\"DnsServer\\": [\\n \\"{\\\\\\"DnsServer\\\\\\": [\\\\\\"vip1.alidns.com\\\\\\",\\\\\\"vip2.alidns.com\\\\\\"]}\\"\\n ]\\n },\\n \\"DDosDefendQuery\\": 50,\\n \\"DnsSecurity\\": \\"advanced\\",\\n \\"DomainType\\": \\"PUBLIC\\",\\n \\"URLForwardCount\\": 20,\\n \\"TTLMinValue\\": 10,\\n \\"PaymentType\\": \\"Subscription\\",\\n \\"VersionName\\": \\"企业旗舰版\\",\\n \\"OverseaLine\\": \\"海外大洲\\",\\n \\"ISPRegionLines\\": \\"电信_浙江\\",\\n \\"Gslb\\": true,\\n \\"BindUsedCount\\": 1,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-xxxxxxx\\",\\n \\"DnsSLBCount\\": 15,\\n \\"InstanceId\\": \\"i-8fxxx\\",\\n \\"MonitorTaskCount\\": 2,\\n \\"StartTime\\": \\"2015-12-12T09:23Z\\",\\n \\"DDosDefendFlow\\": 50,\\n \\"MonitorFrequency\\": 50,\\n \\"SearchEngineLines\\": \\"谷歌\\",\\n \\"BindDomainUsedCount\\": 3,\\n \\"VersionCode\\": \\"version1\\",\\n \\"OverseaDDosDefendFlow\\": 1,\\n \\"InClean\\": false,\\n \\"SubDomainLevel\\": 6,\\n \\"Domain\\": \\"example.com\\",\\n \\"AutoRenewal\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 5\\n false\\n 5\\n true\\n 3\\n 2015-12-12T09:23Z\\n 1474335170000\\n 电信、移动、联通、教育网\\n 1474335170000\\n {\\"DnsServer\\": [\\"vip1.alidns.com\\",\\"vip2.alidns.com\\"]}\\n 50\\n advanced\\n PUBLIC\\n 20\\n 10\\n Subscription\\n 企业旗舰版\\n 海外大洲\\n 电信(省份)、移动(省份)、联通(省份)、教育网(省份)\\n true\\n 1\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 15\\n i-8fxxx\\n 2\\n 2015-12-12T09:23Z\\n 50\\n 50\\n 搜索引擎、谷歌、百度、必应\\n 3\\n version1\\n 1\\n false\\n 6\\n example.com\\n","errorExample":""}]',
'title' => '获取付费版DNS产品实例详情',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsProductInstances' => [
'summary' => '根据传入参数获取付费版DNS产品实例列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsT5OPHE',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.0',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '1000',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'VersionCode',
'in' => 'query',
'schema' => [
'description' => '云解析产品code。',
'type' => 'string',
'required' => false,
'example' => 'version1',
],
],
[
'name' => 'DomainType',
'in' => 'query',
'schema' => [
'description' => '域名类型,大小写不敏感。取值:'."\n"
."\n"
.'- PUBLIC:权威托管域名(默认值)'."\n"
."\n"
.'- CACHE:权威代理域名',
'type' => 'string',
'required' => false,
'example' => 'PUBLIC',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'description' => '排序参数。取值:'."\n"
.'- createDate:按创建时间排序(为空时默认按创建时间排序)'."\n"
.'- expireDate:按过期时间排序',
'type' => 'string',
'required' => false,
'example' => 'createDate',
],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'description' => '排序方向。取值:'."\n"
.'- DESC:递减(为空时默认递减排序) '."\n"
.'- ASC: 递增',
'type' => 'string',
'required' => false,
'example' => 'DESC',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '本次查询获取的付费版DNS产品实例数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'DomainType' => [
'description' => '域名类型,取值:'."\n"
."\n"
.'- PUBLIC:权威托管域名(默认值)'."\n"
."\n"
.'- CACHE:权威代理域名',
'type' => 'string',
'example' => 'PUBLIC',
],
'PageSize' => [
'description' => '本次查询获取的域名数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38xxxxx',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'DnsProducts' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsProduct' => [
'description' => '本次获取的付费版DNS产品实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OverseaLine' => [
'description' => '海外解析请求来源线路。',
'type' => 'string',
'example' => '海外大洲',
],
'PaymentType' => [
'description' => '付费类型。',
'type' => 'string',
'example' => 'Subscription',
],
'MonitorNodeCount' => [
'description' => '监控节点个数(个)。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'InBlackHole' => [
'description' => '域名是否处于黑洞状态。'."\n"
."\n"
.'- true:处于黑洞状态'."\n"
."\n"
.'- false:非黑洞状态',
'type' => 'boolean',
'example' => 'false',
],
'BindDomainUsedCount' => [
'description' => '适用于个人版、企业旗舰版用户调用,指付费版DNS实例已绑定使用的域名个数。',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'ISPRegionLines' => [
'description' => '运营商解析请求来源线路列表。'."\n"
.'- 电信(省份)'."\n"
.'- 移动(省份)'."\n"
.'- 联通(省份)'."\n"
.'- 教育网(省份)',
'type' => 'string',
'example' => '电信_浙江',
],
'TTLMinValue' => [
'description' => '最小TTL值(秒)。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'ISPLines' => [
'description' => '运营商解析请求来源线路列表。'."\n"
.'- 中国电信'."\n"
.'- 中国移动'."\n"
.'- 中国联通'."\n"
.'- 中国教育网'."\n"
.'- 中国广电网'."\n"
.'- 中国鹏博士',
'type' => 'string',
'example' => '中国电信',
],
'SearchEngineLines' => [
'description' => '搜索引擎解析请求来源线路列表。'."\n"
.'- 谷歌'."\n"
.'- 百度'."\n"
.'- 必应'."\n"
.'- 有道',
'type' => 'string',
'example' => '谷歌',
],
'EndTimestamp' => [
'description' => '实例到期时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1474335170000',
],
'VersionName' => [
'description' => '云解析产品版本名称。',
'type' => 'string',
'example' => '企业旗舰版',
],
'VersionCode' => [
'description' => '云解析产品code。',
'type' => 'string',
'example' => 'version1',
],
'MonitorTaskCount' => [
'description' => '监控任务数(个)。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'BindUsedCount' => [
'description' => '适用于定制版用户调用,指付费版DNS实例已使用的更换域名次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Domain' => [
'description' => '绑定域名。',
'type' => 'string',
'example' => 'example.com',
],
'MonitorFrequency' => [
'description' => '监控频率(单位:分钟)。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'InClean' => [
'description' => '域名是否处于清洗状态。',
'type' => 'boolean',
'example' => 'false',
],
'URLForwardCount' => [
'description' => 'URL转发数量(个)。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'StartTimestamp' => [
'description' => '实例购买时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1474335170000',
],
'DDosDefendQuery' => [
'description' => '适用于定制版用户调用,DNS防护QPS(万qps)。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'InstanceId' => [
'description' => '云解析产品ID。',
'type' => 'string',
'example' => 'i-8fj',
],
'DDosDefendFlow' => [
'description' => 'DNS防护流量(G)。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'BindCount' => [
'description' => '适用于定制版用户调用,指付费版DNS实例可支持更换域名次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'SubDomainLevel' => [
'description' => '子域名级别(个)。',
'type' => 'integer',
'format' => 'int64',
'example' => '6',
],
'BindDomainCount' => [
'description' => '适用于个人版、企业旗舰版用户调用,指付费版DNS实例可以绑定的域名个数。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'EndTime' => [
'description' => '实例到期时间。',
'type' => 'string',
'example' => '2015-12-12T00:00Z',
],
'StartTime' => [
'description' => '实例购买时间。',
'type' => 'string',
'example' => '2015-11-12T09:23Z',
],
'OverseaDDosDefendFlow' => [
'description' => '海外DNS防护(G)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'RegionLines' => [
'description' => '是否是地域线路。'."\n"
.'- true:地域线路'."\n"
.'- false:非地域线路',
'type' => 'boolean',
'example' => 'true',
],
'Gslb' => [
'description' => '是否允许GSLB。'."\n"
.'- true:允许'."\n"
.'- false:不允许',
'type' => 'boolean',
'example' => 'true',
],
'DnsSecurity' => [
'description' => 'DNS安全。取值:'."\n"
.'- no:不需要'."\n"
.'- basic:dns攻击基础防御'."\n"
.'- advanced:dns攻击全力防御',
'type' => 'string',
'example' => 'no',
],
'DnsSLBCount' => [
'description' => '负载均衡(单域名、单线路的IP地址容量)。',
'type' => 'integer',
'format' => 'int64',
'example' => '15',
],
'AutoRenewal' => [
'description' => '续费状态。'."\n"
.'- true:自动续费类型。'."\n"
.'- false:非自动续费类型。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"DomainType\\": \\"PUBLIC\\",\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38xxxxx\\",\\n \\"PageNumber\\": 1,\\n \\"DnsProducts\\": {\\n \\"DnsProduct\\": [\\n {\\n \\"OverseaLine\\": \\"海外大洲\\",\\n \\"PaymentType\\": \\"Subscription\\",\\n \\"MonitorNodeCount\\": 5,\\n \\"InBlackHole\\": false,\\n \\"BindDomainUsedCount\\": 3,\\n \\"ISPRegionLines\\": \\"电信_浙江\\",\\n \\"TTLMinValue\\": 10,\\n \\"ISPLines\\": \\"中国电信\\",\\n \\"SearchEngineLines\\": \\"谷歌\\",\\n \\"EndTimestamp\\": 1474335170000,\\n \\"VersionName\\": \\"企业旗舰版\\",\\n \\"VersionCode\\": \\"version1\\",\\n \\"MonitorTaskCount\\": 2,\\n \\"BindUsedCount\\": 1,\\n \\"Domain\\": \\"example.com\\",\\n \\"MonitorFrequency\\": 50,\\n \\"InClean\\": false,\\n \\"URLForwardCount\\": 20,\\n \\"StartTimestamp\\": 1474335170000,\\n \\"DDosDefendQuery\\": 50,\\n \\"InstanceId\\": \\"i-8fj\\",\\n \\"DDosDefendFlow\\": 50,\\n \\"BindCount\\": 3,\\n \\"SubDomainLevel\\": 6,\\n \\"BindDomainCount\\": 5,\\n \\"EndTime\\": \\"2015-12-12T00:00Z\\",\\n \\"StartTime\\": \\"2015-11-12T09:23Z\\",\\n \\"OverseaDDosDefendFlow\\": 1,\\n \\"RegionLines\\": true,\\n \\"Gslb\\": true,\\n \\"DnsSecurity\\": \\"no\\",\\n \\"DnsSLBCount\\": 15,\\n \\"AutoRenewal\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n PUBLIC\\n 2\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 1\\n \\n 海外大洲\\n Subscription\\n 5\\n false\\n 3\\n 电信(省份)、移动(省份)、联通(省份)、教育网(省份)\\n 10\\n 电信、移动、联通、教育网\\n 搜索引擎、谷歌、百度、必应\\n 1474335170000\\n 企业旗舰版\\n version1\\n 2\\n 1\\n example.com\\n 50\\n false\\n 20\\n 1474335170000\\n 50\\n i-8fj\\n 50\\n 3\\n 6\\n 5\\n 2015-12-12T09:23Z\\n 2015-12-12T09:23Z\\n 1\\n true\\n true\\n no\\n 15\\n \\n","errorExample":""}]',
'title' => '获取付费版DNS产品实例列表',
'description' => '> **如果返回参数中未包含域名,则表示该云解析产品尚未绑定任何域名。**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeInstanceDomains' => [
'summary' => '获取实例绑定域名列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsT5OPHE',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。可通过调用[DescribeDomainInfo](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomaininfo?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取。'."\n"
.'可通过调用[DescribeDomainInfo](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomaininfo?spm=a2c63.p38356.help-menu-search-29697.d_0)获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dns-cn-9lb38ldq9**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '68386699-8B9E-4D5B-BC4C-75A28F6C2A00',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'InstanceDomains' => [
'description' => '实例绑定域名列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreateTime' => [
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2020-03-09T02:15Z',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.top',
],
'CreateTimestamp' => [
'description' => '实例创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1583720154000',
],
],
],
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalItems' => [
'description' => '总计。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"68386699-8B9E-4D5B-BC4C-75A28F6C2A00\\",\\n \\"PageNumber\\": 1,\\n \\"InstanceDomains\\": [\\n {\\n \\"CreateTime\\": \\"2020-03-09T02:15Z\\",\\n \\"DomainName\\": \\"example.top\\",\\n \\"CreateTimestamp\\": 1583720154000\\n }\\n ],\\n \\"TotalPages\\": 2,\\n \\"TotalItems\\": 2\\n}","errorExample":""},{"type":"xml","example":"EC467B88-BD3D-4537-8F44-37F125BE5E65\\n20\\n1\\n\\n example.com\\n 2020-03-09T02:15Z\\n 1583720154000\\n\\n1\\n1","errorExample":""}]',
'title' => '获取实例绑定域名列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => '访问[公共错误码](https://next.api.aliyun.com/document/Alidns/2015-01-09/errorCode)查看更多错误码。',
],
'AddDomain' => [
'summary' => '根据传入参数添加域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '指域名分组ID。如不填或传空字符或传defaultGroup,将添加在默认分组下。可通过调用 AddDomainGroup获取。',
'type' => 'string',
'required' => false,
'example' => 'defaultGroup',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '域名在资源管理产品中所属的资源组ID。默认为空,即属于默认资源组。',
'type' => 'string',
'required' => false,
'example' => '******resourcegroupid',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => 'MyGroup',
],
'DomainId' => [
'description' => '域名ID。',
'type' => 'string',
'example' => 'xxxxx6615cf240c697f9f7e207xxxxxx',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'xxx508EF-00FD-xxx9-95A4-1E10BACxxxxx',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'PunyCode' => [
'description' => '只针对中文域名返回punycode码。',
'type' => 'string',
'example' => 'xn--fsq270a.com',
],
'DnsServers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsServer' => [
'description' => '域名在解析系统中的DNS列表。',
'type' => 'array',
'items' => [
'description' => '域名当前设置的DNS服务器名称。',
'type' => 'string',
'example' => '{"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]}',
],
],
],
],
'GroupId' => [
'description' => '域名分组ID。',
'type' => 'string',
'example' => 'defaultGroup',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GroupName\\": \\"MyGroup\\",\\n \\"DomainId\\": \\"xxxxx6615cf240c697f9f7e207xxxxxx\\",\\n \\"RequestId\\": \\"xxx508EF-00FD-xxx9-95A4-1E10BACxxxxx\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"PunyCode\\": \\"xn--fsq270a.com\\",\\n \\"DnsServers\\": {\\n \\"DnsServer\\": [\\n \\"{\\\\\\"DnsServer\\\\\\": [\\\\\\"ns1.alidns.com\\\\\\",\\\\\\"ns2.alidns.com\\\\\\"]}\\"\\n ]\\n },\\n \\"GroupId\\": \\"defaultGroup\\"\\n}","type":"json"}]',
'title' => '添加域名',
'description' => '域名合法性判断参见:'."\n"
.'[域名合法性](https://help.aliyun.com/document_detail/67788.html)。'."\n"
.'[域名合法性](https://www.alibabacloud.com/help/zh/doc-detail/67788.htm)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteDomain' => [
'summary' => '根据传入参数删除域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '云解析中已存在的域名。可通过调用[DescribeDomains ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0) 获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"DomainName\\": \\"example.com\\"\\n}","type":"json"}]',
'title' => '删除域名',
],
'DescribeDomains' => [
'summary' => '根据传入参数查询该用户的域名列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:zh',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => [
'description' => '关键字,按照“%KeyWord%”模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'com',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '指域名分组ID。'."\n"
."\n"
.'如不填或传空字符,将在全部域名下查询。'."\n"
."\n"
.'如传defaultGroup,将在默认分组下查询。',
'type' => 'string',
'required' => false,
'example' => 'defaultGroup',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'SearchMode',
'in' => 'query',
'schema' => [
'description' => '搜索模式。取值:'."\n"
."\n"
.'- **LIKE**:模糊搜索'."\n"
.'- **EXACT**:精确搜索'."\n"
."\n"
.'默认:LIKE',
'type' => 'string',
'required' => false,
'example' => 'LIKE',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-re********',
],
],
[
'name' => 'Starmark',
'in' => 'query',
'schema' => [
'description' => '是否查询域名星标。取值:'."\n"
."\n"
.'- **true**:是'."\n"
."\n"
.'- **false**:**否**'."\n"
."\n"
.'默认:true',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Domains' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Domain' => [
'description' => '本次获取的域名列表。',
'type' => 'array',
'items' => [
'description' => '本次获取的域名列表。',
'type' => 'object',
'properties' => [
'Remark' => [
'description' => '备注。',
'type' => 'string',
'example' => 'remark',
],
'CreateTime' => [
'description' => '域名添加时间。',
'type' => 'string',
'example' => '2019-01-30T05:25Z',
],
'RecordCount' => [
'description' => '域名含有的解析记录条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签键值对数组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => '测试标签',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => '测试标签值',
],
],
],
],
],
],
'InstanceId' => [
'description' => '云解析产品ID。',
'type' => 'string',
'example' => 'i-***',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com'."\n",
],
'DomainId' => [
'description' => '域名ID。',
'type' => 'string',
'example' => '00efd71a-770e-4255-*********',
],
'AliDomain' => [
'description' => '是否为阿里云万网域名。',
'type' => 'boolean',
'example' => 'true',
],
'GroupId' => [
'description' => '域名分组ID。',
'type' => 'string',
'example' => '2***',
],
'GroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => 'mygroup',
],
'ResourceGroupId' => [
'description' => '所属资源组ID。',
'type' => 'string',
'example' => 'rg***',
],
'InstanceEndTime' => [
'description' => '实例的到期时间。',
'type' => 'string',
'example' => '2020-03-14T16:00Z',
],
'InstanceExpired' => [
'description' => '实例是否过期。',
'type' => 'boolean',
'example' => 'false',
],
'VersionName' => [
'description' => '云解析产品名称。',
'type' => 'string',
'example' => '企业旗舰版',
],
'DnsServers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsServer' => [
'description' => '云解析系统分配的DNS服务器名称列表。',
'type' => 'array',
'items' => [
'description' => '云解析系统分配的DNS服务器名称。',
'type' => 'string',
'example' => '{"DnsServer": ["ns1.alidns.com","ns2.alidns.com"]}',
],
],
],
],
'VersionCode' => [
'description' => '云解析版本Code。',
'type' => 'string',
'example' => 'version_enterprise_basic',
],
'PunyCode' => [
'description' => '中文域名的punycode码,英文域名返回为空。',
'type' => 'string',
'example' => 'example.com'."\n",
],
'RegistrantEmail' => [
'description' => '注册人邮箱。',
'type' => 'string',
'example' => '****@example.com',
],
'CreateTimestamp' => [
'description' => '添加时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1660546144000',
],
'Starmark' => [
'description' => '是否收藏至常用域名列表。',
'type' => 'boolean',
'example' => 'true',
],
'DomainLoggingSwitchStatus' => [
'description' => '域名DNS流量分析开启状态:'."\n"
."\n"
.'- OPEN:开启'."\n"
."\n"
.'- CLOSE:关闭',
'type' => 'string',
'example' => 'OPEN',
],
'SlaveDnsStatus' => [
'type' => 'string',
],
],
],
],
],
],
'TotalCount' => [
'description' => '域名列表总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '68386699-8B9E-4D5B-BC4C-75A28F6C2A00',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Domains\\": {\\n \\"Domain\\": [\\n {\\n \\"Remark\\": \\"remark\\",\\n \\"CreateTime\\": \\"2019-01-30T05:25Z\\",\\n \\"RecordCount\\": 100,\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"测试标签\\",\\n \\"Value\\": \\"测试标签值\\"\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"i-***\\",\\n \\"DomainName\\": \\"example.com\\\\n\\",\\n \\"DomainId\\": \\"00efd71a-770e-4255-*********\\",\\n \\"AliDomain\\": true,\\n \\"GroupId\\": \\"2***\\",\\n \\"GroupName\\": \\"mygroup\\",\\n \\"ResourceGroupId\\": \\"rg***\\",\\n \\"InstanceEndTime\\": \\"2020-03-14T16:00Z\\",\\n \\"InstanceExpired\\": false,\\n \\"VersionName\\": \\"企业旗舰版\\",\\n \\"DnsServers\\": {\\n \\"DnsServer\\": [\\n \\"{\\\\\\"DnsServer\\\\\\": [\\\\\\"ns1.alidns.com\\\\\\",\\\\\\"ns2.alidns.com\\\\\\"]}\\"\\n ]\\n },\\n \\"VersionCode\\": \\"version_enterprise_basic\\",\\n \\"PunyCode\\": \\"example.com\\\\n\\",\\n \\"RegistrantEmail\\": \\"****@example.com\\",\\n \\"CreateTimestamp\\": 1660546144000,\\n \\"Starmark\\": true,\\n \\"DomainLoggingSwitchStatus\\": \\"OPEN\\",\\n \\"SlaveDnsStatus\\": \\"\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"68386699-8B9E-4D5B-BC4C-75A28F6C2A00\\",\\n \\"PageNumber\\": 1\\n}","type":"json"}]',
'title' => '获取域名列表',
'description' => '1. 可以指定页码(PageNumber)和每页的数量(PageSize)来获取域名列表。'."\n"
.'2. 可以指定域名的关键字(KeyWord)来查询含有该关键字的域名列表。'."\n"
.'3. 域名列表的默认排序方式是按照域名添加的时间从新到旧排序的。'."\n"
.'4. 可以指定域名分组的ID(GroupId),全部域名代表所有域名、默认分组代表未设置分组的域名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDomainInfo' => [
'summary' => '根据传入参数查询指定域名的信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认值:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains ](~~2357286~~)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'NeedDetailAttributes',
'in' => 'query',
'schema' => [
'description' => '是否返回域名详细的属性,取值范围:'."\n"
.'- true:'."\n"
.'- false '."\n"
."\n"
.'默认值:false,不需要细节属性。'."\n"
."\n"
.'当值为**true**时,则返回以下数据:lineType、minTtl、recordLineTreeJson、recordLines、lineCode、lineDisplayName、lineName、regionLines、slaveDns。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RecordLineTreeJson' => [
'description' => '树形化解析请求来源线路列表。',
'type' => 'string',
'example' => '{"default":{},"unicom":{},"telecom":{},"mobile":{},"edu":{},"oversea":{},"baidu":{},"biying":{},"google":{}}',
],
'GroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => 'mygroup',
],
'InBlackHole' => [
'description' => '是否在黑洞中。',
'type' => 'boolean',
'example' => 'false',
],
'RegionLines' => [
'description' => '是否是地域线路。',
'type' => 'boolean',
'example' => 'false',
],
'SlaveDns' => [
'description' => '是否允许有辅助dns。',
'type' => 'boolean',
'example' => 'true',
],
'AliDomain' => [
'description' => '是否为阿里云万网域名。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-aek3dj3******',
],
'InstanceId' => [
'description' => '云解析产品ID。',
'type' => 'string',
'example' => 'i-7**',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-12-12T09:23Z',
],
'PunyCode' => [
'description' => '只针对中文域名返回punycode码。',
'type' => 'string',
'example' => 'example.com',
],
'DnsServers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsServer' => [
'description' => '域名在解析系统中的DNS列表',
'type' => 'array',
'items' => [
'description' => 'DNS信息。',
'type' => 'string',
'example' => '["vip3.alidns.com", "vip4.alidns.com"]',
],
],
],
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'example' => 'remark',
],
'GroupId' => [
'description' => '域名分组ID。',
'type' => 'string',
'example' => '2***',
],
'VersionCode' => [
'description' => '云解析版本ID。取值范围:'."\n"
.'- version_enterprise_advanced:企业旗舰版'."\n"
.'- version_personal 个人版'."\n"
.'- mianfei:免费版',
'type' => 'string',
'example' => 'mianfei',
],
'RecordLines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RecordLine' => [
'description' => '解析请求来源线路数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FatherCode' => [
'description' => '父线路Code,如果没有则为空。',
'type' => 'string',
'example' => 'internal',
],
'LineDisplayName' => [
'description' => '父线路展示名。',
'type' => 'string',
'example' => '中国地区_西北',
],
'LineCode' => [
'description' => '子线路Code。',
'type' => 'string',
'example' => 'cn_region_xibei',
],
'LineName' => [
'description' => '子线路展示名。',
'type' => 'string',
'example' => '西北',
],
],
],
],
],
],
'DomainId' => [
'description' => '域名ID。',
'type' => 'string',
'example' => '00efd71a-7************',
],
'AvailableTtls' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AvailableTtl' => [
'description' => '域名当前可用TTL列表。默认不返回,需要设置NeedDetailAttributes=true。',
'type' => 'array',
'items' => [
'description' => '可用TTL列表。',
'type' => 'string',
'example' => '[600,1800,3600,43200,86400]',
],
],
],
],
'MinTtl' => [
'description' => '最小TTL。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'InClean' => [
'description' => '是否在清洗中。',
'type' => 'boolean',
'example' => 'false',
],
'VersionName' => [
'description' => '云解析产品名称。',
'type' => 'string',
'example' => '企业旗舰版',
],
'LineType' => [
'description' => '解析请求来源线路类型。',
'type' => 'string',
'example' => 'region_province',
],
'SubDomain' => [
'description' => '查询的 domain 是否是托管的子域名。'."\n"
.'取值:'."\n"
.'- true'."\n"
.'- false',
'type' => 'boolean',
'example' => 'false',
],
'DomainLoggingSwitchStatus' => [
'description' => '日志开关状态',
'type' => 'string',
'example' => 'CLOSE:关闭状态'."\n"
.'OPEN:开启状态',
],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RecordLineTreeJson\\": \\"{\\\\\\"default\\\\\\":{},\\\\\\"unicom\\\\\\":{},\\\\\\"telecom\\\\\\":{},\\\\\\"mobile\\\\\\":{},\\\\\\"edu\\\\\\":{},\\\\\\"oversea\\\\\\":{},\\\\\\"baidu\\\\\\":{},\\\\\\"biying\\\\\\":{},\\\\\\"google\\\\\\":{}}\\",\\n \\"GroupName\\": \\"mygroup\\",\\n \\"InBlackHole\\": false,\\n \\"RegionLines\\": false,\\n \\"SlaveDns\\": true,\\n \\"AliDomain\\": true,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"ResourceGroupId\\": \\"rg-aek3dj3******\\",\\n \\"InstanceId\\": \\"i-7**\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"CreateTime\\": \\"2015-12-12T09:23Z\\",\\n \\"PunyCode\\": \\"example.com\\",\\n \\"DnsServers\\": {\\n \\"DnsServer\\": [\\n \\"[\\\\\\"vip3.alidns.com\\\\\\", \\\\\\"vip4.alidns.com\\\\\\"]\\"\\n ]\\n },\\n \\"Remark\\": \\"remark\\",\\n \\"GroupId\\": \\"2***\\",\\n \\"VersionCode\\": \\"mianfei\\",\\n \\"RecordLines\\": {\\n \\"RecordLine\\": [\\n {\\n \\"FatherCode\\": \\"internal\\",\\n \\"LineDisplayName\\": \\"中国地区_西北\\",\\n \\"LineCode\\": \\"cn_region_xibei\\",\\n \\"LineName\\": \\"西北\\"\\n }\\n ]\\n },\\n \\"DomainId\\": \\"00efd71a-7************\\",\\n \\"AvailableTtls\\": {\\n \\"AvailableTtl\\": [\\n \\"[600,1800,3600,43200,86400]\\"\\n ]\\n },\\n \\"MinTtl\\": 1,\\n \\"InClean\\": false,\\n \\"VersionName\\": \\"企业旗舰版\\",\\n \\"LineType\\": \\"region_province\\",\\n \\"SubDomain\\": false,\\n \\"DomainLoggingSwitchStatus\\": \\"CLOSE:关闭状态\\\\nOPEN:开启状态\\"\\n}","errorExample":""},{"type":"xml","example":"dns-example.com\\n{\\"default\\":{},\\"aliyun\\":{\\"aliyun_r_cn-hangzhou\\":[],\\"aliyun_r_cn-shanghai\\":[],\\"aliyun_r_cn-qingdao\\":[],\\"aliyun_r_cn-beijing\\":[],\\"aliyun_r_cn-zhangjiakou\\":[],\\"aliyun_r_cn-huhehaote\\":[],\\"aliyun_r_cn-wulanchabu\\":[],\\"aliyun_r_cn-shenzhen\\":[],\\"aliyun_r_cn-heyuan\\":[],\\"aliyun_r_cn-guangzhou\\":[],\\"aliyun_r_cn-chengdu\\":[],\\"aliyun_r_cn-hongkong\\":[],\\"aliyun_r_ap-southeast-1\\":[],\\"aliyun_r_ap-southeast-2\\":[],\\"aliyun_r_ap-southeast-3\\":[],\\"aliyun_r_ap-southeast-5\\":[],\\"aliyun_r_ap-northeast-1\\":[],\\"aliyun_r_eu-central-1\\":[],\\"aliyun_r_eu-west-1\\":[],\\"aliyun_r_us-west-1\\":[],\\"aliyun_r_us-east-1\\":[],\\"aliyun_r_ap-south-1\\":[],\\"aliyun_r_me-east-1\\":[]},\\"unicom\\":{\\"cn_unicom_xizang\\":[],\\"cn_unicom_jiangxi\\":[],\\"cn_unicom_hunan\\":[],\\"cn_unicom_xinjiang\\":[],\\"cn_unicom_ningxia\\":[],\\"cn_unicom_tianjin\\":[],\\"cn_unicom_sichuan\\":[],\\"cn_unicom_guangxi\\":[],\\"cn_unicom_yunnan\\":[],\\"cn_unicom_guangdong\\":[],\\"cn_unicom_anhui\\":[],\\"cn_unicom_shanghai\\":[],\\"cn_unicom_fujian\\":[],\\"cn_unicom_qinghai\\":[],\\"cn_unicom_shanxi\\":[],\\"cn_unicom_henan\\":[],\\"cn_unicom_guizhou\\":[],\\"cn_unicom_liaoning\\":[],\\"cn_unicom_gansu\\":[],\\"cn_unicom_chongqing\\":[],\\"cn_unicom_heilongjiang\\":[],\\"cn_unicom_hubei\\":[],\\"cn_unicom_jiangsu\\":[],\\"cn_unicom_jilin\\":[],\\"cn_unicom_shandong\\":[],\\"cn_unicom_beijing\\":[],\\"cn_unicom_neimenggu\\":[],\\"cn_unicom_hainan\\":[],\\"cn_unicom_shaanxi\\":[],\\"cn_unicom_hebei\\":[],\\"cn_unicom_zhejiang\\":[]},\\"telecom\\":{\\"cn_telecom_xinjiang\\":[],\\"cn_telecom_hubei\\":[],\\"cn_telecom_guizhou\\":[],\\"cn_telecom_yunnan\\":[],\\"cn_telecom_shanghai\\":[],\\"cn_telecom_shaanxi\\":[],\\"cn_telecom_beijing\\":[],\\"cn_telecom_sichuan\\":[],\\"cn_telecom_zhejiang\\":[],\\"cn_telecom_ningxia\\":[],\\"cn_telecom_jilin\\":[],\\"cn_telecom_qinghai\\":[],\\"cn_telecom_fujian\\":[],\\"cn_telecom_hunan\\":[],\\"cn_telecom_shandong\\":[],\\"cn_telecom_guangdong\\":[],\\"cn_telecom_chongqing\\":[],\\"cn_telecom_henan\\":[],\\"cn_telecom_hainan\\":[],\\"cn_telecom_anhui\\":[],\\"cn_telecom_jiangsu\\":[],\\"cn_telecom_gansu\\":[],\\"cn_telecom_guangxi\\":[],\\"cn_telecom_liaoning\\":[],\\"cn_telecom_hebei\\":[],\\"cn_telecom_jiangxi\\":[],\\"cn_telecom_neimenggu\\":[],\\"cn_telecom_tianjin\\":[],\\"cn_telecom_xizang\\":[],\\"cn_telecom_heilongjiang\\":[],\\"cn_telecom_shanxi\\":[]},\\"mobile\\":{\\"cn_mobile_sichuan\\":[],\\"cn_mobile_liaoning\\":[],\\"cn_mobile_ningxia\\":[],\\"cn_mobile_qinghai\\":[],\\"cn_mobile_shanxi\\":[],\\"cn_mobile_beijing\\":[],\\"cn_mobile_yunnan\\":[],\\"cn_mobile_heilongjiang\\":[],\\"cn_mobile_henan\\":[],\\"cn_mobile_shaanxi\\":[],\\"cn_mobile_gansu\\":[],\\"cn_mobile_jilin\\":[],\\"cn_mobile_guangxi\\":[],\\"cn_mobile_jiangxi\\":[],\\"cn_mobile_shanghai\\":[],\\"cn_mobile_xinjiang\\":[],\\"cn_mobile_xizang\\":[],\\"cn_mobile_tianjin\\":[],\\"cn_mobile_hunan\\":[],\\"cn_mobile_neimenggu\\":[],\\"cn_mobile_zhejiang\\":[],\\"cn_mobile_hebei\\":[],\\"cn_mobile_guizhou\\":[],\\"cn_mobile_jiangsu\\":[],\\"cn_mobile_guangdong\\":[],\\"cn_mobile_chongqing\\":[],\\"cn_mobile_hainan\\":[],\\"cn_mobile_fujian\\":[],\\"cn_mobile_shandong\\":[],\\"cn_mobile_anhui\\":[],\\"cn_mobile_hubei\\":[]},\\"edu\\":{\\"cn_edu_guizhou\\":[],\\"cn_edu_guangdong\\":[],\\"cn_edu_hainan\\":[],\\"cn_edu_jilin\\":[],\\"cn_edu_gansu\\":[],\\"cn_edu_tianjin\\":[],\\"cn_edu_shanxi\\":[],\\"cn_edu_jiangsu\\":[],\\"cn_edu_hunan\\":[],\\"cn_edu_shandong\\":[],\\"cn_edu_xizang\\":[],\\"cn_edu_yunnan\\":[],\\"cn_edu_shaanxi\\":[],\\"cn_edu_heilongjiang\\":[],\\"cn_edu_hubei\\":[],\\"cn_edu_xinjiang\\":[],\\"cn_edu_zhejiang\\":[],\\"cn_edu_jiangxi\\":[],\\"cn_edu_chongqing\\":[],\\"cn_edu_sichuan\\":[],\\"cn_edu_qinghai\\":[],\\"cn_edu_henan\\":[],\\"cn_edu_neimenggu\\":[],\\"cn_edu_anhui\\":[],\\"cn_edu_beijing\\":[],\\"cn_edu_guangxi\\":[],\\"cn_edu_liaoning\\":[],\\"cn_edu_ningxia\\":[],\\"cn_edu_fujian\\":[],\\"cn_edu_shanghai\\":[],\\"cn_edu_hebei\\":[]},\\"drpeng\\":{\\"cn_drpeng_qinghai\\":[],\\"cn_drpeng_shanghai\\":[],\\"cn_drpeng_jiangsu\\":[],\\"cn_drpeng_yunnan\\":[],\\"cn_drpeng_liaoning\\":[],\\"cn_drpeng_beijing\\":[],\\"cn_drpeng_fujian\\":[],\\"cn_drpeng_shanxi\\":[],\\"cn_drpeng_jiangxi\\":[],\\"cn_drpeng_gansu\\":[],\\"cn_drpeng_jilin\\":[],\\"cn_drpeng_guangdong\\":[],\\"cn_drpeng_hubei\\":[],\\"cn_drpeng_ningxia\\":[],\\"cn_drpeng_hainan\\":[],\\"cn_drpeng_hebei\\":[],\\"cn_drpeng_heilongjiang\\":[],\\"cn_drpeng_xizang\\":[],\\"cn_drpeng_anhui\\":[],\\"cn_drpeng_hunan\\":[],\\"cn_drpeng_henan\\":[],\\"cn_drpeng_neimenggu\\":[],\\"cn_drpeng_guangxi\\":[],\\"cn_drpeng_shandong\\":[],\\"cn_drpeng_xinjiang\\":[],\\"cn_drpeng_guizhou\\":[],\\"cn_drpeng_sichuan\\":[],\\"cn_drpeng_chongqing\\":[],\\"cn_drpeng_shaanxi\\":[],\\"cn_drpeng_tianjin\\":[],\\"cn_drpeng_zhejiang\\":[]},\\"btvn\\":{\\"cn_btvn_hebei\\":[],\\"cn_btvn_qinghai\\":[],\\"cn_btvn_shanxi\\":[],\\"cn_btvn_ningxia\\":[],\\"cn_btvn_guangxi\\":[],\\"cn_btvn_jiangsu\\":[],\\"cn_btvn_guangdong\\":[],\\"cn_btvn_jilin\\":[],\\"cn_btvn_shanghai\\":[],\\"cn_btvn_henan\\":[],\\"cn_btvn_tianjin\\":[],\\"cn_btvn_anhui\\":[],\\"cn_btvn_guizhou\\":[],\\"cn_btvn_chongqing\\":[],\\"cn_btvn_liaoning\\":[],\\"cn_btvn_xizang\\":[],\\"cn_btvn_zhejiang\\":[],\\"cn_btvn_xinjiang\\":[],\\"cn_btvn_yunnan\\":[],\\"cn_btvn_shandong\\":[],\\"cn_btvn_neimenggu\\":[],\\"cn_btvn_shaanxi\\":[],\\"cn_btvn_fujian\\":[],\\"cn_btvn_beijing\\":[],\\"cn_btvn_heilongjiang\\":[],\\"cn_btvn_gansu\\":[],\\"cn_btvn_sichuan\\":[],\\"cn_btvn_hubei\\":[],\\"cn_btvn_hunan\\":[],\\"cn_btvn_hainan\\":[],\\"cn_btvn_jiangxi\\":[]},\\"oversea\\":{\\"os_asia\\":[\\"os_asia_tr\\",\\"os_asia_om\\",\\"os_asia_kz\\",\\"os_asia_ae\\",\\"os_asia_kr\\",\\"os_asia_tw\\",\\"os_asia_pk\\",\\"os_asia_ir\\",\\"os_asia_uz\\",\\"os_asia_mm\\",\\"os_asia_id\\",\\"os_asia_bh\\",\\"os_asia_my\\",\\"os_asia_lb\\",\\"os_asia_kp\\",\\"os_asia_qa\\",\\"os_asia_vn\\",\\"os_asia_sy\\",\\"os_asia_ph\\",\\"os_asia_kw\\",\\"os_asia_mn\\",\\"os_asia_mo\\",\\"os_asia_kh\\",\\"os_asia_mv\\",\\"os_asia_la\\",\\"os_asia_sg\\",\\"os_asia_np\\",\\"os_asia_sa\\",\\"os_asia_iq\\",\\"os_asia_th\\",\\"os_asia_jp\\",\\"os_asia_in\\",\\"os_asia_hk\\",\\"os_asia_il\\"],\\"os_africa\\":[\\"os_africa_ao\\",\\"os_africa_gh\\",\\"os_africa_sc\\",\\"os_africa_dz\\",\\"os_africa_ng\\",\\"os_africa_sd\\",\\"os_africa_cm\\",\\"os_africa_ss\\",\\"os_africa_ci\\",\\"os_africa_sn\\",\\"os_africa_eg\\",\\"os_africa_za\\",\\"os_africa_ke\\",\\"os_africa_ma\\"],\\"os_namerica\\":[\\"os_namerica_ca\\",\\"os_namerica_us\\",\\"os_namerica_cu\\",\\"os_namerica_mx\\"],\\"os_oceanica\\":[\\"os_oceanica_nz\\",\\"os_oceanica_fj\\",\\"os_oceanica_au\\",\\"os_oceanica_pw\\"],\\"os_samerica\\":[\\"os_samerica_ec\\",\\"os_samerica_uy\\",\\"os_samerica_ar\\",\\"os_samerica_br\\",\\"os_samerica_co\\",\\"os_samerica_cl\\",\\"os_samerica_py\\",\\"os_samerica_ve\\",\\"os_samerica_bo\\",\\"os_samerica_pe\\"],\\"os_euro\\":[\\"os_euro_hr\\",\\"os_euro_es\\",\\"os_euro_pl\\",\\"os_euro_pt\\",\\"os_euro_ch\\",\\"os_euro_dk\\",\\"os_euro_ua\\",\\"os_euro_it\\",\\"os_euro_de\\",\\"os_euro_fi\\",\\"os_euro_fr\\",\\"os_euro_ro\\",\\"os_euro_ie\\",\\"os_euro_be\\",\\"os_euro_hu\\",\\"os_euro_se\\",\\"os_euro_by\\",\\"os_euro_lt\\",\\"os_euro_sk\\",\\"os_euro_cz\\",\\"os_euro_nl\\",\\"os_euro_gb\\",\\"os_euro_at\\",\\"os_euro_bg\\",\\"os_euro_is\\",\\"os_euro_si\\",\\"os_euro_ru\\"]},\\"search\\":{\\"google\\":[],\\"baidu\\":[],\\"biying\\":[],\\"youdao\\":[]},\\"hra1e0-1161\\":{},\\"hra15r-864\\":{},\\"hra15q-863\\":{},\\"hra15p-862\\":{},\\"hra15o-861\\":{},\\"hra15n-860\\":{},\\"hra14m-823\\":{}}\\nfalse\\ntrue\\nCA8F8FEE-BE0E-4DC8-AEA8-0B2EAD4CB756\\ntrue\\ntrue\\nrg-acfmw2vjqzvwrfi\\ndns-example.com\\ndns-cn-st21yjlom5j\\n2019-01-30T05:25Z\\ndns-example.com\\n\\n vip3.alidns.com\\n vip4.alidns.com\\n\\n\\nde0efd8ff83c4178946fe37fa6eafaf4\\nversion_enterprise_advanced\\n\\n \\n 默认\\n default\\n 默认\\n \\n \\n 阿里云\\n aliyun\\n 阿里云\\n \\n \\n aliyun\\n 阿里云_华东1(杭州)\\n aliyun_r_cn-hangzhou\\n 华东1(杭州)\\n \\n \\n aliyun\\n 阿里云_华东2(上海)\\n aliyun_r_cn-shanghai\\n 华东2(上海)\\n \\n \\n aliyun\\n 阿里云_华北1(青岛)\\n aliyun_r_cn-qingdao\\n 华北1(青岛)\\n \\n \\n aliyun\\n 阿里云_华北2(北京)\\n aliyun_r_cn-beijing\\n 华北2(北京)\\n \\n \\n aliyun\\n 阿里云_华北3(张家口)\\n aliyun_r_cn-zhangjiakou\\n 华北3(张家口)\\n \\n \\n aliyun\\n 阿里云_华北5(呼和浩特)\\n aliyun_r_cn-huhehaote\\n 华北5(呼和浩特)\\n \\n \\n aliyun\\n 阿里云_华北6(乌兰察布)\\n aliyun_r_cn-wulanchabu\\n 华北6(乌兰察布)\\n \\n \\n aliyun\\n 阿里云_华南1(深圳)\\n aliyun_r_cn-shenzhen\\n 华南1(深圳)\\n \\n \\n aliyun\\n 阿里云_华南2(河源)\\n aliyun_r_cn-heyuan\\n 华南2(河源)\\n \\n \\n aliyun\\n 阿里云_华南3(广州)\\n aliyun_r_cn-guangzhou\\n 华南3(广州)\\n \\n \\n aliyun\\n 阿里云_西南1(成都)\\n aliyun_r_cn-chengdu\\n 西南1(成都)\\n \\n \\n aliyun\\n 阿里云_中国(香港)\\n aliyun_r_cn-hongkong\\n 中国(香港)\\n \\n \\n aliyun\\n 阿里云_新加坡\\n aliyun_r_ap-southeast-1\\n 新加坡\\n \\n \\n aliyun\\n 阿里云_澳大利亚(悉尼)\\n aliyun_r_ap-southeast-2\\n 澳大利亚(悉尼)\\n \\n \\n aliyun\\n 阿里云_马来西亚(吉隆坡)\\n aliyun_r_ap-southeast-3\\n 马来西亚(吉隆坡)\\n \\n \\n aliyun\\n 阿里云_印度尼西亚(雅加达)\\n aliyun_r_ap-southeast-5\\n 印度尼西亚(雅加达)\\n \\n \\n aliyun\\n 阿里云_日本(东京)\\n aliyun_r_ap-northeast-1\\n 日本(东京)\\n \\n \\n aliyun\\n 阿里云_德国(法兰克福)\\n aliyun_r_eu-central-1\\n 德国(法兰克福)\\n \\n \\n aliyun\\n 阿里云_英国(伦敦)\\n aliyun_r_eu-west-1\\n 英国(伦敦)\\n \\n \\n aliyun\\n 阿里云_美国(硅谷)\\n aliyun_r_us-west-1\\n 美国(硅谷)\\n \\n \\n aliyun\\n 阿里云_美国(弗吉尼亚)\\n aliyun_r_us-east-1\\n 美国(弗吉尼亚)\\n \\n \\n aliyun\\n 阿里云_印度(孟买)\\n aliyun_r_ap-south-1\\n 印度(孟买)\\n \\n \\n aliyun\\n 阿里云_中东东部 1 (迪拜)\\n aliyun_r_me-east-1\\n 中东东部 1 (迪拜)\\n \\n \\n 中国联通\\n unicom\\n 中国联通\\n \\n \\n unicom\\n 中国联通_西藏\\n cn_unicom_xizang\\n 西藏\\n \\n \\n unicom\\n 中国联通_江西\\n cn_unicom_jiangxi\\n 江西\\n \\n \\n unicom\\n 中国联通_湖南\\n cn_unicom_hunan\\n 湖南\\n \\n \\n unicom\\n 中国联通_新疆\\n cn_unicom_xinjiang\\n 新疆\\n \\n \\n unicom\\n 中国联通_宁夏\\n cn_unicom_ningxia\\n 宁夏\\n \\n \\n unicom\\n 中国联通_天津\\n cn_unicom_tianjin\\n 天津\\n \\n \\n unicom\\n 中国联通_四川\\n cn_unicom_sichuan\\n 四川\\n \\n \\n unicom\\n 中国联通_广西\\n cn_unicom_guangxi\\n 广西\\n \\n \\n unicom\\n 中国联通_云南\\n cn_unicom_yunnan\\n 云南\\n \\n \\n unicom\\n 中国联通_广东\\n cn_unicom_guangdong\\n 广东\\n \\n \\n unicom\\n 中国联通_安徽\\n cn_unicom_anhui\\n 安徽\\n \\n \\n unicom\\n 中国联通_上海\\n cn_unicom_shanghai\\n 上海\\n \\n \\n unicom\\n 中国联通_福建\\n cn_unicom_fujian\\n 福建\\n \\n \\n unicom\\n 中国联通_青海\\n cn_unicom_qinghai\\n 青海\\n \\n \\n unicom\\n 中国联通_山西\\n cn_unicom_shanxi\\n 山西\\n \\n \\n unicom\\n 中国联通_河南\\n cn_unicom_henan\\n 河南\\n \\n \\n unicom\\n 中国联通_贵州\\n cn_unicom_guizhou\\n 贵州\\n \\n \\n unicom\\n 中国联通_辽宁\\n cn_unicom_liaoning\\n 辽宁\\n \\n \\n unicom\\n 中国联通_甘肃\\n cn_unicom_gansu\\n 甘肃\\n \\n \\n unicom\\n 中国联通_重庆\\n cn_unicom_chongqing\\n 重庆\\n \\n \\n unicom\\n 中国联通_黑龙江\\n cn_unicom_heilongjiang\\n 黑龙江\\n \\n \\n unicom\\n 中国联通_湖北\\n cn_unicom_hubei\\n 湖北\\n \\n \\n unicom\\n 中国联通_江苏\\n cn_unicom_jiangsu\\n 江苏\\n \\n \\n unicom\\n 中国联通_吉林\\n cn_unicom_jilin\\n 吉林\\n \\n \\n unicom\\n 中国联通_山东\\n cn_unicom_shandong\\n 山东\\n \\n \\n unicom\\n 中国联通_北京\\n cn_unicom_beijing\\n 北京\\n \\n \\n unicom\\n 中国联通_内蒙古\\n cn_unicom_neimenggu\\n 内蒙古\\n \\n \\n unicom\\n 中国联通_海南\\n cn_unicom_hainan\\n 海南\\n \\n \\n unicom\\n 中国联通_陕西\\n cn_unicom_shaanxi\\n 陕西\\n \\n \\n unicom\\n 中国联通_河北\\n cn_unicom_hebei\\n 河北\\n \\n \\n unicom\\n 中国联通_浙江\\n cn_unicom_zhejiang\\n 浙江\\n \\n \\n 中国电信\\n telecom\\n 中国电信\\n \\n \\n telecom\\n 中国电信_新疆\\n cn_telecom_xinjiang\\n 新疆\\n \\n \\n telecom\\n 中国电信_湖北\\n cn_telecom_hubei\\n 湖北\\n \\n \\n telecom\\n 中国电信_贵州\\n cn_telecom_guizhou\\n 贵州\\n \\n \\n telecom\\n 中国电信_云南\\n cn_telecom_yunnan\\n 云南\\n \\n \\n telecom\\n 中国电信_上海\\n cn_telecom_shanghai\\n 上海\\n \\n \\n telecom\\n 中国电信_陕西\\n cn_telecom_shaanxi\\n 陕西\\n \\n \\n telecom\\n 中国电信_北京\\n cn_telecom_beijing\\n 北京\\n \\n \\n telecom\\n 中国电信_四川\\n cn_telecom_sichuan\\n 四川\\n \\n \\n telecom\\n 中国电信_浙江\\n cn_telecom_zhejiang\\n 浙江\\n \\n \\n telecom\\n 中国电信_宁夏\\n cn_telecom_ningxia\\n 宁夏\\n \\n \\n telecom\\n 中国电信_吉林\\n cn_telecom_jilin\\n 吉林\\n \\n \\n telecom\\n 中国电信_青海\\n cn_telecom_qinghai\\n 青海\\n \\n \\n telecom\\n 中国电信_福建\\n cn_telecom_fujian\\n 福建\\n \\n \\n telecom\\n 中国电信_湖南\\n cn_telecom_hunan\\n 湖南\\n \\n \\n telecom\\n 中国电信_山东\\n cn_telecom_shandong\\n 山东\\n \\n \\n telecom\\n 中国电信_广东\\n cn_telecom_guangdong\\n 广东\\n \\n \\n telecom\\n 中国电信_重庆\\n cn_telecom_chongqing\\n 重庆\\n \\n \\n telecom\\n 中国电信_河南\\n cn_telecom_henan\\n 河南\\n \\n \\n telecom\\n 中国电信_海南\\n cn_telecom_hainan\\n 海南\\n \\n \\n telecom\\n 中国电信_安徽\\n cn_telecom_anhui\\n 安徽\\n \\n \\n telecom\\n 中国电信_江苏\\n cn_telecom_jiangsu\\n 江苏\\n \\n \\n telecom\\n 中国电信_甘肃\\n cn_telecom_gansu\\n 甘肃\\n \\n \\n telecom\\n 中国电信_广西\\n cn_telecom_guangxi\\n 广西\\n \\n \\n telecom\\n 中国电信_辽宁\\n cn_telecom_liaoning\\n 辽宁\\n \\n \\n telecom\\n 中国电信_河北\\n cn_telecom_hebei\\n 河北\\n \\n \\n telecom\\n 中国电信_江西\\n cn_telecom_jiangxi\\n 江西\\n \\n \\n telecom\\n 中国电信_内蒙古\\n cn_telecom_neimenggu\\n 内蒙古\\n \\n \\n telecom\\n 中国电信_天津\\n cn_telecom_tianjin\\n 天津\\n \\n \\n telecom\\n 中国电信_西藏\\n cn_telecom_xizang\\n 西藏\\n \\n \\n telecom\\n 中国电信_黑龙江\\n cn_telecom_heilongjiang\\n 黑龙江\\n \\n \\n telecom\\n 中国电信_山西\\n cn_telecom_shanxi\\n 山西\\n \\n \\n 中国移动\\n mobile\\n 中国移动\\n \\n \\n mobile\\n 中国移动_四川\\n cn_mobile_sichuan\\n 四川\\n \\n \\n mobile\\n 中国移动_辽宁\\n cn_mobile_liaoning\\n 辽宁\\n \\n \\n mobile\\n 中国移动_宁夏\\n cn_mobile_ningxia\\n 宁夏\\n \\n \\n mobile\\n 中国移动_青海\\n cn_mobile_qinghai\\n 青海\\n \\n \\n mobile\\n 中国移动_山西\\n cn_mobile_shanxi\\n 山西\\n \\n \\n mobile\\n 中国移动_北京\\n cn_mobile_beijing\\n 北京\\n \\n \\n mobile\\n 中国移动_云南\\n cn_mobile_yunnan\\n 云南\\n \\n \\n mobile\\n 中国移动_黑龙江\\n cn_mobile_heilongjiang\\n 黑龙江\\n \\n \\n mobile\\n 中国移动_河南\\n cn_mobile_henan\\n 河南\\n \\n \\n mobile\\n 中国移动_陕西\\n cn_mobile_shaanxi\\n 陕西\\n \\n \\n mobile\\n 中国移动_甘肃\\n cn_mobile_gansu\\n 甘肃\\n \\n \\n mobile\\n 中国移动_吉林\\n cn_mobile_jilin\\n 吉林\\n \\n \\n mobile\\n 中国移动_广西\\n cn_mobile_guangxi\\n 广西\\n \\n \\n mobile\\n 中国移动_江西\\n cn_mobile_jiangxi\\n 江西\\n \\n \\n mobile\\n 中国移动_上海\\n cn_mobile_shanghai\\n 上海\\n \\n \\n mobile\\n 中国移动_新疆\\n cn_mobile_xinjiang\\n 新疆\\n \\n \\n mobile\\n 中国移动_西藏\\n cn_mobile_xizang\\n 西藏\\n \\n \\n mobile\\n 中国移动_天津\\n cn_mobile_tianjin\\n 天津\\n \\n \\n mobile\\n 中国移动_湖南\\n cn_mobile_hunan\\n 湖南\\n \\n \\n mobile\\n 中国移动_内蒙古\\n cn_mobile_neimenggu\\n 内蒙古\\n \\n \\n mobile\\n 中国移动_浙江\\n cn_mobile_zhejiang\\n 浙江\\n \\n \\n mobile\\n 中国移动_河北\\n cn_mobile_hebei\\n 河北\\n \\n \\n mobile\\n 中国移动_贵州\\n cn_mobile_guizhou\\n 贵州\\n \\n \\n mobile\\n 中国移动_江苏\\n cn_mobile_jiangsu\\n 江苏\\n \\n \\n mobile\\n 中国移动_广东\\n cn_mobile_guangdong\\n 广东\\n \\n \\n mobile\\n 中国移动_重庆\\n cn_mobile_chongqing\\n 重庆\\n \\n \\n mobile\\n 中国移动_海南\\n cn_mobile_hainan\\n 海南\\n \\n \\n mobile\\n 中国移动_福建\\n cn_mobile_fujian\\n 福建\\n \\n \\n mobile\\n 中国移动_山东\\n cn_mobile_shandong\\n 山东\\n \\n \\n mobile\\n 中国移动_安徽\\n cn_mobile_anhui\\n 安徽\\n \\n \\n mobile\\n 中国移动_湖北\\n cn_mobile_hubei\\n 湖北\\n \\n \\n 中国教育网\\n edu\\n 中国教育网\\n \\n \\n edu\\n 中国教育网_贵州\\n cn_edu_guizhou\\n 贵州\\n \\n \\n edu\\n 中国教育网_广东\\n cn_edu_guangdong\\n 广东\\n \\n \\n edu\\n 中国教育网_海南\\n cn_edu_hainan\\n 海南\\n \\n \\n edu\\n 中国教育网_吉林\\n cn_edu_jilin\\n 吉林\\n \\n \\n edu\\n 中国教育网_甘肃\\n cn_edu_gansu\\n 甘肃\\n \\n \\n edu\\n 中国教育网_天津\\n cn_edu_tianjin\\n 天津\\n \\n \\n edu\\n 中国教育网_山西\\n cn_edu_shanxi\\n 山西\\n \\n \\n edu\\n 中国教育网_江苏\\n cn_edu_jiangsu\\n 江苏\\n \\n \\n edu\\n 中国教育网_湖南\\n cn_edu_hunan\\n 湖南\\n \\n \\n edu\\n 中国教育网_山东\\n cn_edu_shandong\\n 山东\\n \\n \\n edu\\n 中国教育网_西藏\\n cn_edu_xizang\\n 西藏\\n \\n \\n edu\\n 中国教育网_云南\\n cn_edu_yunnan\\n 云南\\n \\n \\n edu\\n 中国教育网_陕西\\n cn_edu_shaanxi\\n 陕西\\n \\n \\n edu\\n 中国教育网_黑龙江\\n cn_edu_heilongjiang\\n 黑龙江\\n \\n \\n edu\\n 中国教育网_湖北\\n cn_edu_hubei\\n 湖北\\n \\n \\n edu\\n 中国教育网_新疆\\n cn_edu_xinjiang\\n 新疆\\n \\n \\n edu\\n 中国教育网_浙江\\n cn_edu_zhejiang\\n 浙江\\n \\n \\n edu\\n 中国教育网_江西\\n cn_edu_jiangxi\\n 江西\\n \\n \\n edu\\n 中国教育网_重庆\\n cn_edu_chongqing\\n 重庆\\n \\n \\n edu\\n 中国教育网_四川\\n cn_edu_sichuan\\n 四川\\n \\n \\n edu\\n 中国教育网_青海\\n cn_edu_qinghai\\n 青海\\n \\n \\n edu\\n 中国教育网_河南\\n cn_edu_henan\\n 河南\\n \\n \\n edu\\n 中国教育网_内蒙古\\n cn_edu_neimenggu\\n 内蒙古\\n \\n \\n edu\\n 中国教育网_安徽\\n cn_edu_anhui\\n 安徽\\n \\n \\n edu\\n 中国教育网_北京\\n cn_edu_beijing\\n 北京\\n \\n \\n edu\\n 中国教育网_广西\\n cn_edu_guangxi\\n 广西\\n \\n \\n edu\\n 中国教育网_辽宁\\n cn_edu_liaoning\\n 辽宁\\n \\n \\n edu\\n 中国教育网_宁夏\\n cn_edu_ningxia\\n 宁夏\\n \\n \\n edu\\n 中国教育网_福建\\n cn_edu_fujian\\n 福建\\n \\n \\n edu\\n 中国教育网_上海\\n cn_edu_shanghai\\n 上海\\n \\n \\n edu\\n 中国教育网_河北\\n cn_edu_hebei\\n 河北\\n \\n \\n 中国鹏博士\\n drpeng\\n 中国鹏博士\\n \\n \\n drpeng\\n 中国鹏博士_青海\\n cn_drpeng_qinghai\\n 青海\\n \\n \\n drpeng\\n 中国鹏博士_上海\\n cn_drpeng_shanghai\\n 上海\\n \\n \\n drpeng\\n 中国鹏博士_江苏\\n cn_drpeng_jiangsu\\n 江苏\\n \\n \\n drpeng\\n 中国鹏博士_云南\\n cn_drpeng_yunnan\\n 云南\\n \\n \\n drpeng\\n 中国鹏博士_辽宁\\n cn_drpeng_liaoning\\n 辽宁\\n \\n \\n drpeng\\n 中国鹏博士_北京\\n cn_drpeng_beijing\\n 北京\\n \\n \\n drpeng\\n 中国鹏博士_福建\\n cn_drpeng_fujian\\n 福建\\n \\n \\n drpeng\\n 中国鹏博士_山西\\n cn_drpeng_shanxi\\n 山西\\n \\n \\n drpeng\\n 中国鹏博士_江西\\n cn_drpeng_jiangxi\\n 江西\\n \\n \\n drpeng\\n 中国鹏博士_甘肃\\n cn_drpeng_gansu\\n 甘肃\\n \\n \\n drpeng\\n 中国鹏博士_吉林\\n cn_drpeng_jilin\\n 吉林\\n \\n \\n drpeng\\n 中国鹏博士_广东\\n cn_drpeng_guangdong\\n 广东\\n \\n \\n drpeng\\n 中国鹏博士_湖北\\n cn_drpeng_hubei\\n 湖北\\n \\n \\n drpeng\\n 中国鹏博士_宁夏\\n cn_drpeng_ningxia\\n 宁夏\\n \\n \\n drpeng\\n 中国鹏博士_海南\\n cn_drpeng_hainan\\n 海南\\n \\n \\n drpeng\\n 中国鹏博士_河北\\n cn_drpeng_hebei\\n 河北\\n \\n \\n drpeng\\n 中国鹏博士_黑龙江\\n cn_drpeng_heilongjiang\\n 黑龙江\\n \\n \\n drpeng\\n 中国鹏博士_西藏\\n cn_drpeng_xizang\\n 西藏\\n \\n \\n drpeng\\n 中国鹏博士_安徽\\n cn_drpeng_anhui\\n 安徽\\n \\n \\n drpeng\\n 中国鹏博士_湖南\\n cn_drpeng_hunan\\n 湖南\\n \\n \\n drpeng\\n 中国鹏博士_河南\\n cn_drpeng_henan\\n 河南\\n \\n \\n drpeng\\n 中国鹏博士_内蒙古\\n cn_drpeng_neimenggu\\n 内蒙古\\n \\n \\n drpeng\\n 中国鹏博士_广西\\n cn_drpeng_guangxi\\n 广西\\n \\n \\n drpeng\\n 中国鹏博士_山东\\n cn_drpeng_shandong\\n 山东\\n \\n \\n drpeng\\n 中国鹏博士_新疆\\n cn_drpeng_xinjiang\\n 新疆\\n \\n \\n drpeng\\n 中国鹏博士_贵州\\n cn_drpeng_guizhou\\n 贵州\\n \\n \\n drpeng\\n 中国鹏博士_四川\\n cn_drpeng_sichuan\\n 四川\\n \\n \\n drpeng\\n 中国鹏博士_重庆\\n cn_drpeng_chongqing\\n 重庆\\n \\n \\n drpeng\\n 中国鹏博士_陕西\\n cn_drpeng_shaanxi\\n 陕西\\n \\n \\n drpeng\\n 中国鹏博士_天津\\n cn_drpeng_tianjin\\n 天津\\n \\n \\n drpeng\\n 中国鹏博士_浙江\\n cn_drpeng_zhejiang\\n 浙江\\n \\n \\n 中国广电网\\n btvn\\n 中国广电网\\n \\n \\n btvn\\n 中国广电网_河北\\n cn_btvn_hebei\\n 河北\\n \\n \\n btvn\\n 中国广电网_青海\\n cn_btvn_qinghai\\n 青海\\n \\n \\n btvn\\n 中国广电网_山西\\n cn_btvn_shanxi\\n 山西\\n \\n \\n btvn\\n 中国广电网_宁夏\\n cn_btvn_ningxia\\n 宁夏\\n \\n \\n btvn\\n 中国广电网_广西\\n cn_btvn_guangxi\\n 广西\\n \\n \\n btvn\\n 中国广电网_江苏\\n cn_btvn_jiangsu\\n 江苏\\n \\n \\n btvn\\n 中国广电网_广东\\n cn_btvn_guangdong\\n 广东\\n \\n \\n btvn\\n 中国广电网_吉林\\n cn_btvn_jilin\\n 吉林\\n \\n \\n btvn\\n 中国广电网_上海\\n cn_btvn_shanghai\\n 上海\\n \\n \\n btvn\\n 中国广电网_河南\\n cn_btvn_henan\\n 河南\\n \\n \\n btvn\\n 中国广电网_天津\\n cn_btvn_tianjin\\n 天津\\n \\n \\n btvn\\n 中国广电网_安徽\\n cn_btvn_anhui\\n 安徽\\n \\n \\n btvn\\n 中国广电网_贵州\\n cn_btvn_guizhou\\n 贵州\\n \\n \\n btvn\\n 中国广电网_重庆\\n cn_btvn_chongqing\\n 重庆\\n \\n \\n btvn\\n 中国广电网_辽宁\\n cn_btvn_liaoning\\n 辽宁\\n \\n \\n btvn\\n 中国广电网_西藏\\n cn_btvn_xizang\\n 西藏\\n \\n \\n btvn\\n 中国广电网_浙江\\n cn_btvn_zhejiang\\n 浙江\\n \\n \\n btvn\\n 中国广电网_新疆\\n cn_btvn_xinjiang\\n 新疆\\n \\n \\n btvn\\n 中国广电网_云南\\n cn_btvn_yunnan\\n 云南\\n \\n \\n btvn\\n 中国广电网_山东\\n cn_btvn_shandong\\n 山东\\n \\n \\n btvn\\n 中国广电网_内蒙古\\n cn_btvn_neimenggu\\n 内蒙古\\n \\n \\n btvn\\n 中国广电网_陕西\\n cn_btvn_shaanxi\\n 陕西\\n \\n \\n btvn\\n 中国广电网_福建\\n cn_btvn_fujian\\n 福建\\n \\n \\n btvn\\n 中国广电网_北京\\n cn_btvn_beijing\\n 北京\\n \\n \\n btvn\\n 中国广电网_黑龙江\\n cn_btvn_heilongjiang\\n 黑龙江\\n \\n \\n btvn\\n 中国广电网_甘肃\\n cn_btvn_gansu\\n 甘肃\\n \\n \\n btvn\\n 中国广电网_四川\\n cn_btvn_sichuan\\n 四川\\n \\n \\n btvn\\n 中国广电网_湖北\\n cn_btvn_hubei\\n 湖北\\n \\n \\n btvn\\n 中国��电网_湖南\\n cn_btvn_hunan\\n 湖南\\n \\n \\n btvn\\n 中国广电网_海南\\n cn_btvn_hainan\\n 海南\\n \\n \\n btvn\\n 中国广电网_江西\\n cn_btvn_jiangxi\\n 江西\\n \\n \\n 境外\\n oversea\\n 境外\\n \\n \\n oversea\\n 世界_亚洲\\n os_asia\\n 亚洲\\n \\n \\n os_asia\\n 亚洲_土耳其\\n os_asia_tr\\n 土耳其\\n \\n \\n os_asia\\n 亚洲_阿曼\\n os_asia_om\\n 阿曼\\n \\n \\n os_asia\\n 亚洲_哈萨克斯坦\\n os_asia_kz\\n 哈萨克斯坦\\n \\n \\n os_asia\\n 亚洲_阿联酋\\n os_asia_ae\\n 阿联酋\\n \\n \\n os_asia\\n 亚洲_韩国\\n os_asia_kr\\n 韩国\\n \\n \\n os_asia\\n 亚洲_中国台湾\\n os_asia_tw\\n 中国台湾\\n \\n \\n os_asia\\n 亚洲_巴基斯坦\\n os_asia_pk\\n 巴基斯坦\\n \\n \\n os_asia\\n 亚洲_伊朗\\n os_asia_ir\\n 伊朗\\n \\n \\n os_asia\\n 亚洲_乌兹别克斯坦\\n os_asia_uz\\n 乌兹别克斯坦\\n \\n \\n os_asia\\n 亚洲_缅甸\\n os_asia_mm\\n 缅甸\\n \\n \\n os_asia\\n 亚洲_印尼\\n os_asia_id\\n 印尼\\n \\n \\n os_asia\\n 亚洲_巴林\\n os_asia_bh\\n 巴林\\n \\n \\n os_asia\\n 亚洲_马来西亚\\n os_asia_my\\n 马来西亚\\n \\n \\n os_asia\\n 亚洲_黎巴嫩\\n os_asia_lb\\n 黎巴嫩\\n \\n \\n os_asia\\n 亚洲_朝鲜\\n os_asia_kp\\n 朝鲜\\n \\n \\n os_asia\\n 亚洲_卡塔尔\\n os_asia_qa\\n 卡塔尔\\n \\n \\n os_asia\\n 亚洲_越南\\n os_asia_vn\\n 越南\\n \\n \\n os_asia\\n 亚洲_叙利亚\\n os_asia_sy\\n 叙利亚\\n \\n \\n os_asia\\n 亚洲_菲律宾\\n os_asia_ph\\n 菲律宾\\n \\n \\n os_asia\\n 亚洲_科威特\\n os_asia_kw\\n 科威特\\n \\n \\n os_asia\\n 亚洲_蒙古\\n os_asia_mn\\n 蒙古\\n \\n \\n os_asia\\n 亚洲_中国澳门\\n os_asia_mo\\n 中国澳门\\n \\n \\n os_asia\\n 亚洲_柬埔寨\\n os_asia_kh\\n 柬埔寨\\n \\n \\n os_asia\\n 亚洲_马尔代夫\\n os_asia_mv\\n 马尔代夫\\n \\n \\n os_asia\\n 亚洲_老挝\\n os_asia_la\\n 老挝\\n \\n \\n os_asia\\n 亚洲_新加坡\\n os_asia_sg\\n 新加坡\\n \\n \\n os_asia\\n 亚洲_尼泊尔\\n os_asia_np\\n 尼泊尔\\n \\n \\n os_asia\\n 亚洲_沙特\\n os_asia_sa\\n 沙特\\n \\n \\n os_asia\\n 亚洲_伊拉克\\n os_asia_iq\\n 伊拉克\\n \\n \\n os_asia\\n 亚洲_泰国\\n os_asia_th\\n 泰国\\n \\n \\n os_asia\\n 亚洲_日本\\n os_asia_jp\\n 日本\\n \\n \\n os_asia\\n 亚洲_印度\\n os_asia_in\\n 印度\\n \\n \\n os_asia\\n 亚洲_中国香港\\n os_asia_hk\\n 中国香港\\n \\n \\n os_asia\\n 亚洲_以色列\\n os_asia_il\\n 以色列\\n \\n \\n oversea\\n 世界_非洲\\n os_africa\\n 非洲\\n \\n \\n os_africa\\n 非洲_安哥拉\\n os_africa_ao\\n 安哥拉\\n \\n \\n os_africa\\n 非洲_加纳\\n os_africa_gh\\n 加纳\\n \\n \\n os_africa\\n 非洲_塞舌尔\\n os_africa_sc\\n 塞舌尔\\n \\n \\n os_africa\\n 非洲_阿尔及利亚\\n os_africa_dz\\n 阿尔及利亚\\n \\n \\n os_africa\\n 非洲_尼日利亚\\n os_africa_ng\\n 尼日利亚\\n \\n \\n os_africa\\n 非洲_苏丹\\n os_africa_sd\\n 苏丹\\n \\n \\n os_africa\\n 非洲_喀麦隆\\n os_africa_cm\\n 喀麦隆\\n \\n \\n os_africa\\n 非洲_南苏丹\\n os_africa_ss\\n 南苏丹\\n \\n \\n os_africa\\n 非洲_科特迪瓦\\n os_africa_ci\\n 科特迪瓦\\n \\n \\n os_africa\\n 非洲_塞内加尔\\n os_africa_sn\\n 塞内加尔\\n \\n \\n os_africa\\n 非洲_埃及\\n os_africa_eg\\n 埃及\\n \\n \\n os_africa\\n 非洲_南非\\n os_africa_za\\n 南非\\n \\n \\n os_africa\\n 非洲_肯尼亚\\n os_africa_ke\\n 肯尼亚\\n \\n \\n os_africa\\n 非洲_摩洛哥\\n os_africa_ma\\n 摩洛哥\\n \\n \\n oversea\\n 世界_北美洲\\n os_namerica\\n 北美洲\\n \\n \\n os_namerica\\n 北美洲_加拿大\\n os_namerica_ca\\n 加拿大\\n \\n \\n os_namerica\\n 北美洲_美国\\n os_namerica_us\\n 美国\\n \\n \\n os_namerica\\n 北美洲_古巴\\n os_namerica_cu\\n 古巴\\n \\n \\n os_namerica\\n 北美洲_墨西哥\\n os_namerica_mx\\n 墨西哥\\n \\n \\n oversea\\n 世界_大洋洲\\n os_oceanica\\n 大洋洲\\n \\n \\n os_oceanica\\n 大洋洲_新西兰\\n os_oceanica_nz\\n 新西兰\\n \\n \\n os_oceanica\\n 大洋洲_斐济\\n os_oceanica_fj\\n 斐济\\n \\n \\n os_oceanica\\n 大洋洲_澳大利亚\\n os_oceanica_au\\n 澳大利亚\\n \\n \\n os_oceanica\\n 大洋洲_帕劳\\n os_oceanica_pw\\n 帕劳\\n \\n \\n oversea\\n 世界_南美洲\\n os_samerica\\n 南美洲\\n \\n \\n os_samerica\\n 南美洲_厄瓜多尔\\n os_samerica_ec\\n 厄瓜多尔\\n \\n \\n os_samerica\\n 南美洲_乌拉圭\\n os_samerica_uy\\n 乌拉圭\\n \\n \\n os_samerica\\n 南美洲_阿根廷\\n os_samerica_ar\\n 阿根廷\\n \\n \\n os_samerica\\n 南美洲_巴西\\n os_samerica_br\\n 巴西\\n \\n \\n os_samerica\\n 南美洲_哥伦比亚\\n os_samerica_co\\n 哥伦比亚\\n \\n \\n os_samerica\\n 南美洲_智利\\n os_samerica_cl\\n 智利\\n \\n \\n os_samerica\\n 南美洲_巴拉圭\\n os_samerica_py\\n 巴拉圭\\n \\n \\n os_samerica\\n 南美洲_委内瑞拉\\n os_samerica_ve\\n 委内瑞拉\\n \\n \\n os_samerica\\n 南美洲_玻利维亚\\n os_samerica_bo\\n 玻利维亚\\n \\n \\n os_samerica\\n 南美洲_秘鲁\\n os_samerica_pe\\n 秘鲁\\n \\n \\n oversea\\n 世界_欧洲\\n os_euro\\n 欧洲\\n \\n \\n os_euro\\n 欧洲_克罗地亚\\n os_euro_hr\\n 克罗地亚\\n \\n \\n os_euro\\n 欧洲_西班牙\\n os_euro_es\\n 西班牙\\n \\n \\n os_euro\\n 欧洲_波兰\\n os_euro_pl\\n 波兰\\n \\n \\n os_euro\\n 欧洲_葡萄牙\\n os_euro_pt\\n 葡萄牙\\n \\n \\n os_euro\\n 欧洲_瑞士\\n os_euro_ch\\n 瑞士\\n \\n \\n os_euro\\n 欧洲_丹麦\\n os_euro_dk\\n 丹麦\\n \\n \\n os_euro\\n 欧洲_乌克兰\\n os_euro_ua\\n 乌克兰\\n \\n \\n os_euro\\n 欧洲_意大利\\n os_euro_it\\n 意大利\\n \\n \\n os_euro\\n 欧洲_德国\\n os_euro_de\\n 德国\\n \\n \\n os_euro\\n 欧洲_芬兰\\n os_euro_fi\\n 芬兰\\n \\n \\n os_euro\\n 欧洲_法国\\n os_euro_fr\\n 法国\\n \\n \\n os_euro\\n 欧洲_罗马尼亚\\n os_euro_ro\\n 罗马尼亚\\n \\n \\n os_euro\\n 欧洲_爱尔兰\\n os_euro_ie\\n 爱尔兰\\n \\n \\n os_euro\\n 欧洲_比利时\\n os_euro_be\\n 比利时\\n \\n \\n os_euro\\n 欧洲_匈牙利\\n os_euro_hu\\n 匈牙利\\n \\n \\n os_euro\\n 欧洲_瑞典\\n os_euro_se\\n 瑞典\\n \\n \\n os_euro\\n 欧洲_白俄罗斯\\n os_euro_by\\n 白俄罗斯\\n \\n \\n os_euro\\n 欧洲_立陶宛\\n os_euro_lt\\n 立陶宛\\n \\n \\n os_euro\\n 欧洲_斯洛伐克\\n os_euro_sk\\n 斯洛伐克\\n \\n \\n os_euro\\n 欧洲_捷克\\n os_euro_cz\\n 捷克\\n \\n \\n os_euro\\n 欧洲_荷兰\\n os_euro_nl\\n 荷兰\\n \\n \\n os_euro\\n 欧洲_英国\\n os_euro_gb\\n 英国\\n \\n \\n os_euro\\n 欧洲_奥地利\\n os_euro_at\\n 奥地利\\n \\n \\n os_euro\\n 欧洲_保加利亚\\n os_euro_bg\\n 保加利亚\\n \\n \\n os_euro\\n 欧洲_冰岛\\n os_euro_is\\n 冰岛\\n \\n \\n os_euro\\n 欧洲_斯洛文尼亚\\n os_euro_si\\n 斯洛文尼亚\\n \\n \\n os_euro\\n 欧洲_俄罗斯\\n os_euro_ru\\n 俄罗斯\\n \\n \\n 搜索引擎\\n search\\n 搜索引擎\\n \\n \\n search\\n 谷歌\\n google\\n 谷歌\\n \\n \\n search\\n 百度\\n baidu\\n 百度\\n \\n \\n search\\n 必应\\n biying\\n 必应\\n \\n \\n search\\n 有道\\n youdao\\n 有道\\n \\n\\nf8f8cd88-f253-48f5-a0ba-befcd5d0dc03\\n\\n 1\\n 5\\n 10\\n 60\\n 120\\n 600\\n 1800\\n 3600\\n 43200\\n 86400\\n\\nAlibaba Cloud DNS\\n1\\nfalse\\nisp","errorExample":""}]',
'title' => '获取域名信息',
'description' => '本示例中域名绑定的实例为企业旗舰版。线路枚举信息可以参考RecordLines的返回值。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddDomainBackup' => [
'summary' => '根据传入的域名名称和备份周期给该域名建立备份。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dns-example.top',
],
],
[
'name' => 'PeriodType',
'in' => 'query',
'schema' => [
'description' => '备份周期,当前支持:'."\n"
."\n"
.'- DAY:每天备份一次'."\n"
.'- HOUR:每小时备份一次',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'HOUR',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PeriodType' => [
'description' => '备份周期。',
'type' => 'string',
'example' => 'HOUR',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'FD552816-FCC8-4832-B4A2-2DA0C2BA1688',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'dns-example.top',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PeriodType\\": \\"HOUR\\",\\n \\"RequestId\\": \\"FD552816-FCC8-4832-B4A2-2DA0C2BA1688\\",\\n \\"DomainName\\": \\"dns-example.top\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n FD552816-FCC8-4832-B4A2-2DA0C2BA1688\\r\\n test.aliyun.com\\r\\n DAY\\r\\n","errorExample":""}]',
'title' => '新建域名备份',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ChangeDomainOfDnsProduct' => [
'summary' => '更换云解析产品绑定的域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsT5OPHE',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '请求和接收消息的语言类型。'."\n"
.'取值:'."\n"
."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文'."\n"
."\n"
.'默认值为**zh**。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '1.1.XX.XX',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '云解析产品ID。'."\n"
.'可通过调用 [ListCloudGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_14_34.14ce3409EfbfOE) 获取。'."\n"
.'可通过调用 [ListCloudGtmInstances ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'i-7XX',
],
],
[
'name' => 'NewDomain',
'in' => 'query',
'schema' => [
'description' => '目标绑定域名,如不填写,则为解绑。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => [
'description' => '是否强制绑定。'."\n"
.'取值:'."\n"
."\n"
.'- **false**:**否**'."\n"
.'- **true**:**是**'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'OriginalDomain' => [
'description' => '原始绑定的域名,如果为空,则为第一次绑定。',
'type' => 'string',
'example' => 'www.example.com',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"OriginalDomain\\": \\"www.example.com\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\r\\n originaldomain.com\\r\\n","errorExample":""}]',
'title' => '更换云解析产品绑定的域名',
'description' => '- **无论当前云解析产品是否绑定域名,都调用此接口。从云解析产品中解绑域名,也调用此接口,即NewDomain为空。**'."\n"
."\n"
.'- **本接口适用于老版本实例,如果是新版本套餐,例如个人版、企业标准版、企业旗舰版实例,请调用BindInstanceDomains接口。**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ModifyHichinaDomainDNS' => [
'summary' => '变更域名绑定的DNS服务器名称,从其他服务商的DNS服务器名称,修改为阿里云解析DNS提供的DNS服务器名称。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.0',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dns-example.top',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'NewDnsServers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsServer' => [
'description' => '域名修改后的DNS服务器列表。',
'type' => 'array',
'items' => [
'description' => '域名修改后的DNS服务器。',
'type' => 'string',
'example' => '{"DnsServer": ["dns9.hichina.com","dns10.hichina.com"]}',
],
],
],
],
'OriginalDnsServers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsServer' => [
'description' => '域名修改前的DNS服务器列表。',
'type' => 'array',
'items' => [
'description' => '域名修改前的DNS服务器。',
'type' => 'string',
'example' => '{"DnsServer": ["NS3.DNSV5.COM","NS4.DNSV5.COM"]}',
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"NewDnsServers\\": {\\n \\"DnsServer\\": [\\n \\"{\\\\\\"DnsServer\\\\\\": [\\\\\\"dns9.hichina.com\\\\\\",\\\\\\"dns10.hichina.com\\\\\\"]}\\"\\n ]\\n },\\n \\"OriginalDnsServers\\": {\\n \\"DnsServer\\": [\\n \\"{\\\\\\"DnsServer\\\\\\": [\\\\\\"NS3.DNSV5.COM\\\\\\",\\\\\\"NS4.DNSV5.COM\\\\\\"]}\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n {\\"DnsServer\\": [\\"dns9.hichina.com\\",\\"dns10.hichina.com\\"]}\\n {\\"DnsServer\\": [\\"NS3.DNSV5.COM\\",\\"NS4.DNSV5.COM\\"]}\\n","errorExample":""}]',
'title' => '修改域名DNS服务器名称',
'description' => '修改成功后,DNS会被修改为云解析DNS(hichina.com结尾的DNS)。'."\n"
.'> **使用前提:适用于阿里云注册域名,且当前DNS服务器是第三方DNS的域名使用。**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDomainRemark' => [
'summary' => '根据传入参数修改域名的备注。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'cn',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '云解析中已存在的域名。可通过调用[DescribeDomains ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '域名的备注信息。'."\n"
."\n"
.'不超过50个字符,可以包含数字、中文、英文和特殊字符:_ - , . ,。',
'type' => 'string',
'required' => false,
'example' => '这是我在阿里云解析的第一个域名',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","errorExample":""},{"type":"xml","example":"\\n536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n","errorExample":""}]',
'title' => '修改域名的备注',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetMainDomainName' => [
'summary' => '通过输入的参数,获取主域名名称。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:zh',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InputString',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RR' => [
'description' => '主机记录信息。',
'type' => 'string',
'example' => 'www',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'DomainLevel' => [
'description' => '输入域名的级别。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RR\\": \\"www\\",\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DomainLevel\\": 2\\n}","type":"json"}]',
'title' => '获取主域名名称',
'description' => '关于主域名和子域名级别,参见:'."\n"
.'[域名级别](https://help.aliyun.com/document_detail/39803.html?spm=a2c4g.2357293.0.0.211f41ffUR1cPb)。 如输入`www.abc.com`,则输出abc.com。'."\n"
.'[域名级别](https://www.alibabacloud.com/help/zh/faq-detail/39803.htm)。 如输入`www.abc.com`,则输出abc.com。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDomainNs' => [
'summary' => '根据传入域名获取域名当前的NS服务器列表,以及NS是否属于阿里云解析管理。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '请求和接收消息的语言类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'zh:中文 '."\n"
.'en:英文 '."\n"
."\n"
.'默认取值为**zh**。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调取[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)接口获取'."\n"
.'可通过调取[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)接口获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AllAliDns' => [
'description' => '是否全部为阿里云解析DNS。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '16C7DC7A-2FA7-4D14-8B12-88A2BB6373DB',
],
'ExpectDnsServers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ExpectDnsServer' => [
'description' => '云解析DNS分配的域名DNS服务器名称。',
'type' => 'array',
'items' => [
'description' => '云解析DNS分配的域名DNS服务器名称。',
'type' => 'string',
'example' => 'x1.alidns.com,x2.alidns.com',
],
],
],
],
'DnsServers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsServer' => [
'description' => '域名当前设置的DNS服务器名称。',
'type' => 'array',
'items' => [
'description' => '域名当前设置的DNS服务器名称。',
'type' => 'string',
'example' => 'vip1.alidns.com,vip2.alidns.com',
],
],
],
],
'IncludeAliDns' => [
'description' => '是否包含阿里云解析DNS。',
'type' => 'boolean',
'example' => 'true',
],
'DetectFailedReasonCode' => [
'description' => '检测失败原因编码。',
'type' => 'string',
'example' => 'DnsCheck.Failed',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AllAliDns\\": true,\\n \\"RequestId\\": \\"16C7DC7A-2FA7-4D14-8B12-88A2BB6373DB\\",\\n \\"ExpectDnsServers\\": {\\n \\"ExpectDnsServer\\": [\\n \\"x1.alidns.com,x2.alidns.com\\"\\n ]\\n },\\n \\"DnsServers\\": {\\n \\"DnsServer\\": [\\n \\"vip1.alidns.com,vip2.alidns.com\\"\\n ]\\n },\\n \\"IncludeAliDns\\": true,\\n \\"DetectFailedReasonCode\\": \\"DnsCheck.Failed\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 16C7DC7A-2FA7-4D14-8B12-88A2BB6373DB\\r\\n true\\r\\n \\r\\n vip1.alidns.com\\r\\n vip2.alidns.com\\r\\n \\r\\n true\\r\\n","errorExample":""}]',
'title' => '获取域名NS服务器列表',
'description' => '> 此接口通过直接查询注册局权威服务器来获取域名DNS服务器名称,如果域名处于未生效状态(例如:serverHold、clientHold、未实名认证),可能会返回异常。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDomainDnssecStatus' => [
'summary' => '开启/关闭域名的DNSSEC服务,仅支持付费版DNS用户。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '要开启DNSSEC服务的DNS域名,仅支持付费版DNS用户。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => 'Dnssec状态:'."\n"
."\n"
.'- ON 开启'."\n"
.'- OFF 关闭',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ON',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","errorExample":""},{"type":"xml","example":"536E9CAD-DB30-4647-AC87-AA5CC38C5382","errorExample":""}]',
'title' => '设置域名DNSSEC状态',
],
'DescribeDomainDnssecInfo' => [
'summary' => '根据传入参数查询指定域名的DNSSEC信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,取值:'."\n"
."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文'."\n"
."\n"
.'默认为**zh**',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => 'Dnssec状态:'."\n"
."\n"
.'- ON:开启'."\n"
.'- OFF:关闭',
'type' => 'string',
'example' => 'ON',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Digest' => [
'description' => '摘要(如果Dnssec开启则返回)。',
'type' => 'string',
'example' => 'C1A0424B97A049F1F9B2EA139CC298533219668164E343BD21203ABC4608C02A',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'PublicKey' => [
'description' => '公钥(如果Dnssec开启则返回)。',
'type' => 'string',
'example' => 'mdsswUyr3DPW132m******************',
],
'DigestType' => [
'description' => '摘要类型(如果Dnssec开启则返回)。',
'type' => 'string',
'example' => 'SHA256',
],
'DsRecord' => [
'description' => 'DS记录(如果Dnssec开启则返回)。',
'type' => 'string',
'example' => 'example.com. 3600 IN DS 2371 13 2 C1A0424B97A049F1F9B2EA139CC29853321966816***************',
],
'KeyTag' => [
'description' => '密钥标签(如果Dnssec开启则返回)。',
'type' => 'string',
'example' => '54931',
],
'Flags' => [
'description' => '标志(如果Dnssec开启则返回)。',
'type' => 'string',
'example' => '257 (KSK)',
],
'Algorithm' => [
'description' => '算法类型(如果Dnssec开启则返回)。',
'type' => 'string',
'example' => '13',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"ON\\",\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Digest\\": \\"C1A0424B97A049F1F9B2EA139CC298533219668164E343BD21203ABC4608C02A\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"PublicKey\\": \\"mdsswUyr3DPW132m******************\\",\\n \\"DigestType\\": \\"SHA256\\",\\n \\"DsRecord\\": \\"example.com. 3600 IN DS 2371 13 2 C1A0424B97A049F1F9B2EA139CC29853321966816***************\\",\\n \\"KeyTag\\": \\"54931\\",\\n \\"Flags\\": \\"257 (KSK)\\",\\n \\"Algorithm\\": \\"13\\"\\n}","errorExample":""},{"type":"xml","example":"ON\\n536E9CAD-DB30-4647-AC87-AA5CC38C5382\\nC1A0424B97A049F1F9B2EA139CC298533219668164E343BD21203ABC4608C02A\\nexample.com\\nmdsswUyr3DPW132mOi8V9xESWE8jTo0dxCjjnopKl+GqJxpVXckHAeF+KkxLbxILfDLUT0rAK9iUzy1L53eKGQ==\\nSHA256\\nexample.com. 3600 IN DS 2371 13 2 C1A0424B97A049F1F9B2EA139CC298533219668164E343BD21203ABC4608C02A\\n54931\\n257 (KSK)\\n13","errorExample":""}]',
'title' => '查询域名的DNSSEC信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BindInstanceDomains' => [
'summary' => '绑定付费版DNS域名到实例ID。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsT5OPHE',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:zh',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '权威域名实例ID(域名绑定的产品实例ID)。可通过调用[ListCloudGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[ListCloudGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 's********',
],
],
[
'name' => 'DomainNames',
'in' => 'query',
'schema' => [
'description' => '域名列表。'."\n"
."\n"
.'>英文 " , ” 号隔开多个域名,最多100个域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com,example.net',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'FailedCount' => [
'description' => '绑定失败个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'SuccessCount' => [
'description' => '绑定成功个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"FailedCount\\": 0,\\n \\"SuccessCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 0\\n 2\\n","errorExample":""}]',
'title' => '绑定付费版DNS域名',
'description' => '实例ID以”dns-“开头的实例为新版实例,支持绑定多个域名,调用接口直接绑定到实例,如果域名个数超过实例的配置,则会报错。
'."\n"
.'实例ID以非”dns-“开头的实例为旧版实例,只支持绑定一个域名,因此调用此接口,如果实例已经绑定域名,则会执行域名换绑操作。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnbindInstanceDomains' => [
'summary' => '根据实例ID解绑付费版DNS的域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsT5OPHE',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainNames',
'in' => 'query',
'schema' => [
'description' => '域名列表。'."\n"
."\n"
.'使用英文“ , ”号隔开多个域名,最多100个域名。域名名称可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'域名名称可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com,example.net',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '权威域名产品实例ID。可通过调用[ListCloudGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[ListCloudGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dns-cn-9lb38ldq9**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '123',
],
'FailedCount' => [
'description' => '域名解绑失败个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'SuccessCount' => [
'description' => '域名解绑成功个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"123\\",\\n \\"FailedCount\\": 0,\\n \\"SuccessCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\n 123\\n 0\\n 2\\n","errorExample":""}]',
'title' => '解绑付费版DNS域名',
'description' => '实例ID以”dns-“开头的实例为新版实例,支持绑定多个域名,调用接口直接绑定到实例,如果域名个数超过实例的配置,则会报错。
'."\n"
.'实例ID以非”dns-“开头的实例为旧版实例,只支持绑定一个域名,因此调用此接口,如果实例已经绑定域名,则会执行域名换绑操作。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'OperateBatchDomain' => [
'summary' => '进行批量操作以添加或删除域名和解析记录。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:zh',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '批量操作类型,取值:'."\n"
."\n"
.'- **DOMAIN_ADD**:批量添加域名'."\n"
.'- **DOMAIN_DEL**:批量删除域名'."\n"
.'- **RR_ADD**:批量添加解析'."\n"
.'- **RR_DEL**:批量删除解析(删除满足N.RR、N.VALUE、N.RR&N.VALUE条件的解析记录。如果无N.RR&&N.VALUE则清空参数DomainRecordInfo.N.Domain下的解析记录)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'RR_ADD',
],
],
[
'name' => 'DomainRecordInfo',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '用户提交的数据(POPAPI确认size,最大1000条数据)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '记录类型。例如:A、AAAA、TXT、MX、CNAME等。'."\n"
."\n"
.'> 批量操作类型为**RR_ADD**、**RR_DEL**时必需。',
'type' => 'string',
'required' => false,
'example' => 'MX',
],
'Value' => [
'description' => '记录值。'."\n"
."\n"
.'> 批量操作类型为**RR_ADD**、**RR_DEL**时必需。',
'type' => 'string',
'required' => false,
'example' => 'fd87da3c4528844d45af39200155a905',
],
'Ttl' => [
'description' => '生效时间(单位:秒),默认***600***。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '600',
],
'Domain' => [
'description' => '域名名称。'."\n"
."\n"
.'> 用户提交的数据, N 从 1 开始,最多 1000 条数据。由于HTTP请求头限制,超过 1000 条的数据会被忽略,不予处理。请勿超过1000条数据。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
'Line' => [
'description' => '解析请求来源。默认:default。',
'type' => 'string',
'required' => false,
'example' => 'default',
],
'NewRr' => [
'description' => '新的主机记录(仅修改操作时使用,外部用户不支持)。',
'type' => 'string',
'required' => false,
'example' => 'mail',
],
'Rr' => [
'description' => '主机记录。'."\n"
."\n"
.'> 批量操作类型为**RR_ADD**、**RR_DEL**时必需。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => 'zhaohui',
],
'Priority' => [
'description' => 'MX优先级。'."\n"
."\n"
.'记录类型为MX时必需。默认:10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
],
'NewType' => [
'description' => '新的记录类型代码(仅修改操作时使用,外部用户不支持)。',
'type' => 'string',
'required' => false,
'example' => 'AAAA',
],
'NewValue' => [
'description' => '新的记录值(仅修改操作时使用,外部用户不支持)。',
'type' => 'string',
'required' => false,
'example' => '114.92.XX.XX',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '任务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '34****',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '75446CC1-FC9A-4595-8D96-089D73D7A63D',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TaskId\\": 0,\\n \\"RequestId\\": \\"75446CC1-FC9A-4595-8D96-089D73D7A63D\\"\\n}","type":"json"}]',
'title' => '批量管理域名和解析记录',
'description' => '使用场景:有大量需要执行的解析操作任务,但是对任务生效效率没有高需求。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddDomainGroup' => [
'summary' => '根据传入参数添加域名分组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '域名分组名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'MyGroup',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => 'NewName',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'GroupId' => [
'description' => '域名分组ID。',
'type' => 'string',
'example' => 'd367113100944e488352f99e3c7d****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"GroupName\\": \\"NewName\\",\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"GroupId\\": \\"d367113100944e488352f99e3c7d****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\r\\n 2223\\r\\n NewName\\r\\n","errorExample":""}]',
'title' => '添加域名分组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDomainGroups' => [
'summary' => '根据传入参数获取域名分组的列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:zh',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => [
'description' => '组名关键字,按照“%KeyWord%”模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'Group',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '110',
'example' => '20',
'default' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DomainGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainGroup' => [
'description' => '域名分组结构列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupId' => [
'description' => '域名分组ID。'."\n"
."\n"
.'- 默认分组GroupId:"defaultGroup",代表未设置分组的域名。'."\n"
.'- 全部域名GroupId:"",代表所有域名。',
'type' => 'string',
'example' => 'defaultGroup',
],
'GroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => 'MyGroup',
],
'DomainCount' => [
'description' => '域名分组数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
],
],
],
],
],
'TotalCount' => [
'description' => '域名分组总数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainGroups\\": {\\n \\"DomainGroup\\": [\\n {\\n \\"GroupId\\": \\"defaultGroup\\",\\n \\"GroupName\\": \\"MyGroup\\",\\n \\"DomainCount\\": 2\\n }\\n ]\\n },\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1\\n}","type":"json"}]',
'title' => '获取域名分组列表',
],
'DeleteDomainGroup' => [
'summary' => '删除域名分组,分组下的域名会被移动到默认分组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '域名分组ID。可通过调取[DescribeDomainGroups](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomaingroups?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调取[DescribeDomainGroups](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomaingroups?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'd367113100944e488352f99e3c7d****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => 'MyGroup',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"GroupName\\": \\"MyGroup\\",\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\r\\n MyGroup\\r\\n","errorExample":""}]',
'title' => '删除域名分组',
'description' => '> 默认分组无法删除。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDomainGroup' => [
'summary' => '根据传入参数修改域名分组名称。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '要修改名称的域名分组ID。可通过调用[DescribeDomainGroups ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomaingroups?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomainGroups ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomaingroups?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '60bb3ef15ace449082cf914ed3ea****',
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '域名分组修改后的新名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'NewName',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '域名分组新名称。',
'type' => 'string',
'example' => 'NewName',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'GroupId' => [
'description' => '域名分组ID。',
'type' => 'string',
'example' => '60bb3ef15ace449082cf914ed3ea****',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"GroupName\\": \\"NewName\\",\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"GroupId\\": \\"60bb3ef15ace449082cf914ed3ea****\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\r\\n 2223\\r\\n NewName\\r\\n","errorExample":""}]',
'title' => '修改域名分组的名称',
'description' => '将已创建的域名分组,修改名称',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ChangeDomainGroup' => [
'summary' => '根据传入参数将域名从原分组更换到新分组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '目标域名分组ID。'."\n"
."\n"
.'- 如不传GroupId,则指将域名放到默认分组下。'."\n"
.'- 如GroupId为空字符"",则指将域名放到默认分组下。'."\n"
.'- 如GroupId为defaultGroup,则指将域名放到默认分组下。'."\n"
.'- 如GroupId不符合上述条件,传入的GroupId验证结果为存在,则更新目标域名的GroupId,不存在则不更新。',
'type' => 'string',
'required' => false,
'example' => '60bb3ef15ace449082cf914ed3ea****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '目标域名分组名称。',
'type' => 'string',
'example' => 'MyGroup',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'GroupId' => [
'description' => '目标域名分组ID。',
'type' => 'string',
'example' => '60bb3ef15ace449082cf914ed3ea****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GroupName\\": \\"MyGroup\\",\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"GroupId\\": \\"60bb3ef15ace449082cf914ed3ea****\\"\\n}","type":"json"}]',
'title' => '将域名从原分组更换到新分组',
'description' => '可以指定域名分组的ID(GroupId),全部域名代表所有域名、默认分组代表未设置分组的域名。',
],
'TransferDomain' => [
'summary' => '根据传入参数批量跨账号转移DNS权限至目标账户。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '请求值,返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:zh',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainNames',
'in' => 'query',
'schema' => [
'description' => '域名列表,英文逗号隔开;仅支持阿里云注册的域名。域名名称可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'域名名称可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com,example.net',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注。',
'type' => 'string',
'required' => false,
'example' => 'test domain transfer',
],
],
[
'name' => 'TargetUserId',
'in' => 'query',
'schema' => [
'description' => '将云解析列表中的域名和解析记录转移到目标用户ID下。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '12*******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '任务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '112233',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskId\\": 112233,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","errorExample":""},{"type":"xml","example":"\\n92901A84-B317-43BE-9610-76B1C7B7ADC7\\n180839\\n","errorExample":""}]',
'title' => '跨账号转移DNS权限',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RetrieveDomain' => [
'summary' => '执行找回域名操作。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:zh',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '9CC0D642-49D4-48DE-A1A5-9F218652E4A7',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9CC0D642-49D4-48DE-A1A5-9F218652E4A7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9CC0D642-49D4-48DE-A1A5-9F218652E4A7\\n","errorExample":""}]',
'title' => '找回域名',
'description' => '域名找回时需要做txt记录验证,请配合[生成txt记录](https://help.aliyun.com/document_detail/145533.html) [生成txt记录](https://www.alibabacloud.com/help/zh/alibaba-cloud-dns/latest/generating-a-txt-record)接口使用。',
],
'DescribeTransferDomains' => [
'summary' => '根据传入参数获取跨账号转移DNS列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '请求和接收消息的语言类型。'."\n"
."\n"
.'取值:'."\n"
."\n"
.'zh:中文 '."\n"
."\n"
.'en:英文'."\n"
."\n"
.' 默认取值为zh。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'TransferType',
'in' => 'query',
'schema' => [
'description' => '转移类型。取值范围:'."\n"
."\n"
.'- IN:转入到本账号的列表'."\n"
.'- OUT:本账号转出的列表',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IN',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称,查询指定域名的转移记录。',
'type' => 'string',
'required' => false,
'example' => 'example.top',
],
],
[
'name' => 'FromUserId',
'in' => 'query',
'schema' => [
'description' => '域名来源账号ID,查看从该ID账号转移给本账号的域名列表',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1*******',
],
],
[
'name' => 'TargetUserId',
'in' => 'query',
'schema' => [
'description' => '域名去处账号ID,查看从本账号转移给该ID账号的域名列表',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1*******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '列表总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'DomainTransfers' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainTransfer' => [
'description' => '跨账号转移DNS列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FromUserId' => [
'description' => '域名转出的原始用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '2*******',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2019-10-30T07:16Z',
],
'TargetUserId' => [
'description' => '转移到的目标用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1*******',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.top',
],
'Id' => [
'description' => '转移记录的ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1*******',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1572419764000',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"DomainTransfers\\": {\\n \\"DomainTransfer\\": [\\n {\\n \\"FromUserId\\": 0,\\n \\"CreateTime\\": \\"2019-10-30T07:16Z\\",\\n \\"TargetUserId\\": 0,\\n \\"DomainName\\": \\"example.top\\",\\n \\"Id\\": 0,\\n \\"CreateTimestamp\\": 1572419764000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n\\n \\n 1574304668000\\n 2019-11-21T02:51Z\\n test.com\\n 1\\n 1111\\n 2222\\n \\n\\n1\\n1\\n20\\nA54C2B66-E857-434D-B77F-BE5B45C89458\\n","errorExample":""}]',
'title' => '获取跨账号转移DNS权限列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDomainStatistics' => [
'summary' => '查询指定主域名请求量的实时数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '请求和接收消息的语言类型。'."\n"
.'- **zh**(默认):中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调取[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)接口获取'."\n"
.'可通过调取[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)接口获取',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:**YYYY-MM-DD**。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90`。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-07-04',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:**YYYY-MM-DD**。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2019-07-04',
],
],
[
'name' => 'DomainType',
'in' => 'query',
'schema' => [
'description' => '域名类型,取值:'."\n"
."\n"
.'- PUBLIC:权威托管域名(默认值)'."\n"
."\n"
.'- CACHE:权威代理域名',
'type' => 'string',
'required' => false,
'example' => 'PUBLIC',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF',
],
'Statistics' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Statistic' => [
'description' => '请求量数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '统计时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1556640000000',
],
'Count' => [
'description' => '请求量(次)。',
'type' => 'integer',
'format' => 'int64',
'example' => '15292887',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF\\",\\n \\"Statistics\\": {\\n \\"Statistic\\": [\\n {\\n \\"Timestamp\\": 1556640000000,\\n \\"Count\\": 15292887,\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF\\n \\n 1556640000000\\n 15292887\\n \\n","errorExample":""}]',
'title' => '获取主域名请求量实时统计',
'description' => '实时数据的统计维度是按小时。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDomainStatisticsSummary' => [
'summary' => '查询用户账号下所有付费域名的请求量列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsG5IRRX',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,取值:'."\n"
."\n"
.'- **zh(默认)**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,最小值为**1**,默认值为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:**YYYY-MM-DD**。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90`。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-07-04',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:**YYYY-MM-DD**。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'example' => '2019-07-04',
],
],
[
'name' => 'SearchMode',
'in' => 'query',
'schema' => [
'description' => '关键词的搜索模式。取值:'."\n"
."\n"
.'- 模糊搜索(默认):**LIKE**'."\n"
.'- 精确搜索:**EXACT**',
'type' => 'string',
'required' => false,
'example' => 'LIKE',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '关键词,按照“%KeyWord%”模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => [
'description' => '查询总量阈值,也可查询相应请求量不大于threshold的数据。例如,如果您将该参数设置为100,可查询出请求量小于100次的域名。为空时查全部的域名',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '0',
'example' => '12',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'CC625C21-8832-4683-BF10-C3CFB1A4FA13',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '数据分页后总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '14',
],
'TotalItems' => [
'description' => '数据总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '68',
],
'Statistics' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Statistic' => [
'description' => '请求量数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'Count' => [
'description' => '请求量(次)。',
'type' => 'integer',
'format' => 'int64',
'example' => '35509014',
],
'DomainType' => [
'description' => '域名类型,大小写不敏感。取值:'."\n"
."\n"
.'PUBLIC:权威托管域名(默认值)'."\n"
."\n"
.'CACHE:权威代理域名',
'type' => 'string',
'example' => 'PUBLIC',
],
'resolveAnalysisStatus' => [
'description' => '域名DNS流量分析开启状态:'."\n"
."\n"
.'- OPEN:开启'."\n"
."\n"
.'- CLOSE:关闭',
'type' => 'string',
'example' => 'OPEN',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 5,\\n \\"RequestId\\": \\"CC625C21-8832-4683-BF10-C3CFB1A4FA13\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 14,\\n \\"TotalItems\\": 68,\\n \\"Statistics\\": {\\n \\"Statistic\\": [\\n {\\n \\"DomainName\\": \\"example.com\\",\\n \\"Count\\": 35509014,\\n \\"DomainType\\": \\"PUBLIC\\",\\n \\"resolveAnalysisStatus\\": \\"OPEN\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1\\r\\n \\r\\n \\r\\n 837871652\\r\\n alitest2.com\\r\\n \\r\\n \\r\\n 50205934\\r\\n dns-example.com\\r\\n \\r\\n \\r\\n 35509014\\r\\n ali-gslb.com\\r\\n \\r\\n \\r\\n 31397370\\r\\n dns-example.cn\\r\\n \\r\\n \\r\\n 3896503\\r\\n mydomi.cn\\r\\n \\r\\n \\r\\n 5\\r\\n CC625C21-8832-4683-BF10-C3CFB1A4FA13\\r\\n 68\\r\\n 14\\r\\n","errorExample":""}]',
'title' => '获取全部域名的请求量统计列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRecordStatistics' => [
'summary' => '查询指定子域名请求量的实时数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsG5IRRX',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh(默认):中文'."\n"
.'- en:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:**YYYY-MM-DD**。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90`。'."\n"
."\n"
.'若查询时间小于等于7天,按照`维度:小时`返回数据,即:`StartDate <= Now - 7`。'."\n"
."\n"
.'若查询时间大于7天,按照`维度:天`返回数据,即:`StartDate > Now - 7`。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-07-04',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:**YYYY-MM-DD**。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'example' => '2019-07-04',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '主域名名称。域名名称。可通过调取[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)接口获取'."\n"
.'可通过调取[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)接口获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'exmaple.com',
],
],
[
'name' => 'Rr',
'in' => 'query',
'schema' => [
'description' => '指主机记录,如果要解析www.exmaple.com,主机记录要填写www。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www',
],
],
[
'name' => 'DomainType',
'in' => 'query',
'schema' => [
'description' => '域名类型,大小写不敏感。取值:'."\n"
."\n"
.'- PUBLIC:权威域名(默认值)'."\n"
."\n"
.'- CACHE:权威代理域名',
'type' => 'string',
'required' => false,
'example' => 'PUBLIC',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF',
],
'Statistics' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Statistic' => [
'description' => '请求量数据列表。',
'type' => 'array',
'items' => [
'description' => '统计数据列表。',
'type' => 'object',
'properties' => [
'Timestamp' => [
'description' => '统计时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1556640000000',
],
'Count' => [
'description' => '请求量(次)。',
'type' => 'integer',
'format' => 'int64',
'example' => '15292887',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF\\",\\n \\"Statistics\\": {\\n \\"Statistic\\": [\\n {\\n \\"Timestamp\\": 1556640000000,\\n \\"Count\\": 15292887\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取子域名请求量实时统计',
'description' => '实时数据的统计维度是按小时。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeRecordStatisticsSummary' => [
'summary' => '查询指定域名下的全部子域名的请求量统计。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsG5IRRX',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,最小值为**1**,默认值为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:**YYYY-MM-DD**。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90。`',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '2019-07-04',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间。格式:**YYYY-MM-DD**。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'example' => '2019-07-04',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.top',
],
],
[
'name' => 'SearchMode',
'in' => 'query',
'schema' => [
'description' => '关键词的搜索模式。取值:'."\n"
."\n"
.'- 模糊搜索(默认):**LIKE**'."\n"
.'- 精确搜索:**EXACT**',
'type' => 'string',
'required' => false,
'example' => 'EXACT',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '关键词,按照“%KeyWord%”模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => [
'description' => '查询解析请求量不大于threshold的域名数据。取值为任意大于等于threshold值的整数。例如:'."\n"
.'- 为100时,查询对应时间段内有解析请求量且小于等于100次的域名。'."\n"
.'- 为空时,查询对应时间段内有解析请求量的全部域名。'."\n"
.'- 为0时,查询对应时间段内无解析请求量的域名,如果是当天添加的域名且没有任何请求量,需要第二天才能查询到。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12',
],
],
[
'name' => 'DomainType',
'in' => 'query',
'schema' => [
'description' => '域名类型,大小写不敏感。取值: '."\n"
."\n"
.'- PUBLIC:权威托管域名(默认值)'."\n"
."\n"
.'- CACHE:权威代理域名',
'type' => 'string',
'required' => false,
'example' => 'PUBLIC',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E49F0023-4A98-486F-8BA3-6003D5664105',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '数据分页后总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '数据总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'Statistics' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Statistic' => [
'description' => '请求量数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SubDomain' => [
'description' => '子域名。',
'type' => 'string',
'example' => 'example.top',
],
'Count' => [
'description' => '请求量(次)。',
'type' => 'integer',
'format' => 'int64',
'example' => '838711553',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"E49F0023-4A98-486F-8BA3-6003D5664105\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 3,\\n \\"Statistics\\": {\\n \\"Statistic\\": [\\n {\\n \\"SubDomain\\": \\"example.top\\",\\n \\"Count\\": 838711553\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 1\\r\\n \\r\\n \\r\\n 838711553\\r\\n t1.alitest2.com\\r\\n \\r\\n \\r\\n 3467\\r\\n alitest2.com\\r\\n \\r\\n \\r\\n 487\\r\\n txt.alitest2.com\\r\\n \\r\\n \\r\\n 20\\r\\n E49F0023-4A98-486F-8BA3-6003D5664105\\r\\n 3\\r\\n 1\\r\\n","errorExample":""}]',
'title' => '获取全部子域名的请求量统计',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDNSSLBSubDomains' => [
'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"
.'- **en**:英文。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户账号IP。',
'type' => 'string',
'required' => false,
'example' => '1.1.XX.XX',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'Rr',
'in' => 'query',
'schema' => [
'description' => '主机记录。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '域名分组数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'SlbSubDomains' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SlbSubDomain' => [
'description' => '权重配置子域名列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '描述:支持设置权重配置的记录类型,取值为:A、AAAA、CNAME。',
'type' => 'string',
'example' => 'A',
],
'RecordCount' => [
'description' => '解析记录数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'Open' => [
'description' => '权重配置的状态。',
'type' => 'boolean',
'example' => 'true',
],
'SubDomain' => [
'description' => '子域名名称。',
'type' => 'string',
'example' => 'test.example.com'."\n",
],
'LineAlgorithms' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LineAlgorithm' => [
'description' => '权重线路列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Line' => [
'description' => '指解析线路,如电信、移动、联通等。',
'type' => 'string',
'example' => 'default',
],
'Open' => [
'description' => '是否开启权重配置。取值:'."\n"
."\n"
.'- **true**(默认):开启'."\n"
.'- **false**:关闭',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"SlbSubDomains\\": {\\n \\"SlbSubDomain\\": [\\n {\\n \\"Type\\": \\"A\\",\\n \\"RecordCount\\": 3,\\n \\"Open\\": true,\\n \\"SubDomain\\": \\"test.example.com\\\\n\\",\\n \\"LineAlgorithms\\": {\\n \\"LineAlgorithm\\": [\\n {\\n \\"Line\\": \\"default\\",\\n \\"Open\\": true\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 1\\n \\n A\\n 3\\n true\\n www.example.com\\n \\n \\n","errorExample":""}]',
'title' => '获取权重配置子域名列表',
'summary' => '根据传入参数获取权重配置子域名列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDomainLogs' => [
'summary' => '根据传入参数获取域名的操作日志。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '请求和接收消息的语言类型。'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文'."\n"
."\n"
.'默认为**zh**',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => [
'description' => '关键字,按照“%KeyWord%”模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '域名分组ID。为空时,查询所有分组',
'type' => 'string',
'required' => false,
'example' => '2****',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '开始时间。格式:**YYYY-MM-DD**。',
'type' => 'string',
'required' => false,
'example' => '2019-07-04',
],
],
[
'name' => 'endDate',
'in' => 'query',
'schema' => [
'description' => '结束时间。格式:**YYYY-MM-DD**。',
'type' => 'string',
'required' => false,
'example' => '2019-07-04',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '查询内容类型。'."\n"
."\n"
.'- domain:域名'."\n"
.'- slavedns:辅助DNS'."\n"
."\n"
.'为空时,查询所有类型',
'type' => 'string',
'required' => false,
'example' => 'domain',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '日志列表中日志的数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'PageSize' => [
'description' => '本次查询获取的日志数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'DomainLogs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainLog' => [
'description' => '域名操作日志列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '操作行为。',
'type' => 'string',
'example' => '添加',
],
'ActionTimestamp' => [
'description' => '操作时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '143562300000',
],
'ZoneId' => [
'description' => 'Zone ID。',
'type' => 'string',
'example' => 'cxfd3******',
],
'ClientIp' => [
'description' => '操作者IP。',
'type' => 'string',
'example' => '182.92.XX.XX',
],
'Message' => [
'description' => '操作消息。',
'type' => 'string',
'example' => '添加到域名解析列表',
],
'ActionTime' => [
'description' => '操作时间。',
'type' => 'string',
'example' => '2015-12-12T09:23Z',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"DomainLogs\\": {\\n \\"DomainLog\\": [\\n {\\n \\"Action\\": \\"添加\\",\\n \\"ActionTimestamp\\": 143562300000,\\n \\"ZoneId\\": \\"cxfd3******\\",\\n \\"ClientIp\\": \\"182.92.XX.XX\\",\\n \\"Message\\": \\"添加到域名解析列表\\",\\n \\"ActionTime\\": \\"2015-12-12T09:23Z\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\r\\n 2\\r\\n 1\\r\\n 2\\r\\n \\r\\n \\r\\n 2015-12-12T09:23Z\\r\\n abc.com\\r\\n 添加\\r\\n 到域名解析列表\\r\\n 182.92.253.20\\r\\n \\r\\n \\r\\n 2015-12-12T09:23Z\\r\\n example.com\\r\\n 找回成功\\r\\n 并添加到域名解析列表\\r\\n 182.92.253.20\\r\\n \\r\\n \\r\\n","errorExample":""}]',
'title' => '获取域名操作日志',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddDomainRecord' => [
'summary' => '根据传入参数添加解析记录。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文'."\n"
.'默认为**zh**',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'RR',
'in' => 'query',
'schema' => [
'description' => '主机记录。'."\n"
."\n"
.'如果要解析exmaple.com,主机记录要填写”@”,而不是空。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '解析记录类型,参见:'."\n"
."\n\n"
.'[解析记录类型格式](https://help.aliyun.com/document_detail/29805.html)'."\n"
."\n\n"
.'[解析记录类型格式](https://www.alibabacloud.com/help/zh/doc-detail/29805.htm)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'A',
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => [
'description' => '记录值。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '192.168.0.1',
],
],
[
'name' => 'TTL',
'in' => 'query',
'schema' => [
'description' => '解析生效时间,默认为600秒(10分钟)。参见:'."\n"
."\n"
.'[TTL定义说明](https://help.aliyun.com/document_detail/29806.html)'."\n"
."\n"
.'[TTL定义说明](https://www.alibabacloud.com/help/zh/doc-detail/29806.htm)',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '86400',
'minimum' => '1',
'example' => '600',
'default' => '600',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'description' => 'MX记录的优先级,取值范围:`[1,50]`。'."\n"
."\n"
.'记录类型为MX记录时,此参数必需,MX 优先级的数值越低,优先级别就越高。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '65535',
'minimum' => '0',
'example' => '1',
],
],
[
'name' => 'Line',
'in' => 'query',
'schema' => [
'description' => '解析线路,默认为**default**。参见:'."\n"
."\n"
.'[解析线路枚举](https://help.aliyun.com/document_detail/29807.html)'."\n"
."\n"
.'[解析线路枚举](https://www.alibabacloud.com/help/zh/doc-detail/29807.htm)',
'type' => 'string',
'required' => false,
'example' => 'default',
'default' => 'default',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'RecordId' => [
'description' => '解析记录的ID。',
'type' => 'string',
'example' => '999******',
],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"RecordId\\": \\"999******\\"\\n}","type":"json"}]',
'title' => '添加解析记录',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteDomainRecord' => [
'summary' => '根据传入参数删除解析记录。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1'."\n",
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '解析记录的ID。可通过调取[DescribeDomainRecords](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c4g.11186623.help-menu-search-29697.d_0)接口获取。'."\n"
.'可通过调取[DescribeDomainRecords](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c63.p38356.help-menu-search-29697.d_0)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '99******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'RecordId' => [
'description' => '解析记录的ID。',
'type' => 'string',
'example' => '99******',
],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"RecordId\\": \\"99******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 9999985\\n","errorExample":""}]',
'title' => '删除解析记录',
],
'DeleteSubDomainRecords' => [
'summary' => '根据传入参数删除主机记录对应的解析记录。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsQIXAM1',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'RR',
'in' => 'query',
'schema' => [
'description' => '主机记录。'."\n"
."\n"
.'如果要解析@.exmaple.com,主机记录要填写”@”,而不是空。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '解析记录类型。如果不填写,则返回子域名对应的全部解析记录类型。'."\n"
."\n"
.'解析类型包括(不区分大小写):**A、MX、CNAME、TXT、REDIRECT_URL、FORWORD_URL、NS、AAAA、SRV**。',
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RR' => [
'description' => '主机记录。',
'type' => 'string',
'example' => 'www',
],
'TotalCount' => [
'description' => '被删除的解析记录总数。',
'type' => 'string',
'example' => '1',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RR\\": \\"www\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","errorExample":""},{"type":"xml","example":"\\n www\\n 1\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n","errorExample":""}]',
'title' => '删除主机记录对应的解析记录',
'description' => '如果被删除的解析记录中存在锁定解析,则该锁定解析不会被删除。',
],
'UpdateDomainRecord' => [
'summary' => '根据传入参数修改解析记录。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1',
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '解析记录的ID。可通过调取[DescribeDomainRecords](~~2357159~~)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '99*******',
],
],
[
'name' => 'RR',
'in' => 'query',
'schema' => [
'description' => '主机记录。'."\n"
.'当设置主域名解析(如example.com)时,主机记录应填写"@"符号。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '@',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '解析记录类型,参见:'."\n"
.'[解析记录类型格式](https://help.aliyun.com/document_detail/29805.html)。'."\n"
.'[解析记录类型格式](https://www.alibabacloud.com/help/zh/doc-detail/29805.htm)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'A',
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => [
'description' => '记录值。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '192.0.2.1',
],
],
[
'name' => 'TTL',
'in' => 'query',
'schema' => [
'description' => '解析生效时间,默认为600秒(10分钟)。'."\n"
.'参见:'."\n"
.'[TTL定义说明](https://help.aliyun.com/document_detail/29806.html)。'."\n"
.'[TTL定义说明](https://www.alibabacloud.com/help/zh/doc-detail/29806.htm)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '86400',
'minimum' => '1',
'example' => '600',
'default' => '600',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'description' => 'MX记录的优先级,取值范围:`[1,50]`。'."\n"
."\n"
.'记录类型为MX记录时,此参数必填。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '65535',
'minimum' => '0',
'example' => '1',
],
],
[
'name' => 'Line',
'in' => 'query',
'schema' => [
'description' => '解析线路,默认为**default**。'."\n"
.'参见:'."\n"
.'[解析线路枚举](https://help.aliyun.com/document_detail/29807.html)。'."\n"
.'[解析线路枚举](https://www.alibabacloud.com/help/zh/doc-detail/29807.htm)。',
'type' => 'string',
'required' => false,
'example' => 'default',
'default' => 'default',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'RecordId' => [
'description' => '解析记录的ID。',
'type' => 'string',
'example' => '99******',
],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"RecordId\\": \\"99******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 9999985\\n","errorExample":""}]',
'title' => '修改域名解析记录',
],
'UpdateDomainRecordRemark' => [
'summary' => '根据传入参数修改解析记录的备注。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1',
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '解析记录的ID。可通过调取[DescribeDomainRecords](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c4g.11186623.help-menu-search-29697.d_0)接口获取。'."\n"
.'可通过调取[DescribeDomainRecords](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c63.p38356.help-menu-search-29697.d_0)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '12*****',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '您的解析记录的备注信息。默认为空,为空时删除原备注信息',
'type' => 'string',
'required' => false,
'example' => '我的第一个解析记录',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n","errorExample":""}]',
'title' => '修改解析记录的备注',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDomainRecordStatus' => [
'summary' => '根据传入参数设置解析记录状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1',
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '解析记录的ID。可通过调取[DescribeDomainRecords](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c4g.11186623.help-menu-search-29697.d_0)接口获取。'."\n"
.'可通过调取[DescribeDomainRecords](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c63.p38356.help-menu-search-29697.d_0)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9********',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '解析记录状态。取值:'."\n"
."\n"
.'- **Enable**: 启用解析 '."\n"
.'- **Disable**: 暂停解析',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Disable',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '当前解析记录状态。',
'type' => 'string',
'example' => 'Disable',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'RecordId' => [
'description' => '解析记录的ID。',
'type' => 'string',
'example' => '9*******',
],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Disable\\",\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"RecordId\\": \\"9*******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Disable\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 9999985\\n","errorExample":""}]',
'title' => '设置解析记录状态',
],
'DescribeDomainRecordInfo' => [
'summary' => '通过解析记录的ID获取解析记录的详细信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1',
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '解析记录的ID。可通过调取[DescribeDomainRecords](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c4g.11186623.help-menu-search-29697.d_0)接口获取。'."\n"
.'可通过调取[DescribeDomainRecords](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c63.p38356.help-menu-search-29697.d_0)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9*********',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '解析记录状态。取值:'."\n"
."\n"
.'Enable: 启用解析'."\n"
."\n"
.'Disable: 暂停解析',
'type' => 'string',
'example' => 'Enable',
],
'RR' => [
'description' => '解析类型。',
'type' => 'string',
'example' => '@',
],
'GroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => 'MyGroup',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'Priority' => [
'description' => 'MX记录的优先级。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'PunyCode' => [
'description' => '只针对中文域名返回punycode码。',
'type' => 'string',
'example' => 'xn--fsq270a.com',
],
'TTL' => [
'description' => '指解析结果在Local DNS中的缓存时间',
'type' => 'integer',
'format' => 'int64',
'example' => '600',
],
'GroupId' => [
'description' => '域名分组ID。',
'type' => 'string',
'example' => '2****',
],
'Line' => [
'description' => '解析线路。',
'type' => 'string',
'example' => 'default',
],
'Locked' => [
'description' => '解析记录锁定状态,取值:**true/false**。',
'type' => 'boolean',
'example' => 'true',
],
'Type' => [
'description' => '记录类型。',
'type' => 'string',
'example' => 'MX',
],
'DomainId' => [
'description' => '域名ID。',
'type' => 'string',
'example' => '00efd71a-7************',
],
'Value' => [
'description' => '记录值。',
'type' => 'string',
'example' => '1.1.XX.XX',
],
'RecordId' => [
'description' => '解析记录的ID。',
'type' => 'string',
'example' => '9******',
],
'Remark' => [
'description' => '您的解析记录的备注信息。'."\n"
."\n",
'type' => 'string',
'example' => 'test',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Enable\\",\\n \\"RR\\": \\"@\\",\\n \\"GroupName\\": \\"MyGroup\\",\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"Priority\\": 5,\\n \\"PunyCode\\": \\"xn--fsq270a.com\\",\\n \\"TTL\\": 600,\\n \\"GroupId\\": \\"2****\\",\\n \\"Line\\": \\"default\\",\\n \\"Locked\\": true,\\n \\"Type\\": \\"MX\\",\\n \\"DomainId\\": \\"00efd71a-7************\\",\\n \\"Value\\": \\"1.1.XX.XX\\",\\n \\"RecordId\\": \\"9******\\",\\n \\"Remark\\": \\"test\\"\\n}","errorExample":""},{"type":"xml","example":"\\n Enable\\n @\\n MyGroup\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n example.com\\n 5\\n xn--fsq270a.com\\n 600\\n 2223\\n default\\n true\\n MX\\n 00efd71a-770e-4255-b54e-6fe5659baffe\\n 192.0.2.254\\n 9999985\\n","errorExample":""}]',
'title' => '获取解析记录的详细信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDomainRecords' => [
'summary' => '根据传入参数获取指定主域名的所有解析记录列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**500**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '500',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => [
'description' => '关键字。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'RRKeyWord',
'in' => 'query',
'schema' => [
'description' => '主机记录的关键字,按照 RRKeyWord(前后模糊匹配)模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'www',
],
],
[
'name' => 'TypeKeyWord',
'in' => 'query',
'schema' => [
'description' => '解析类型的关键字,按照全匹配搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'MX',
],
],
[
'name' => 'ValueKeyWord',
'in' => 'query',
'schema' => [
'description' => '记录值的关键字,按照 ValueKeyWord(前后模糊匹配)模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'com',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'description' => '排序方式。按照解析添加的时间从新到旧排序。',
'type' => 'string',
'required' => false,
'example' => 'default',
],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'description' => '排序方向。取值范围:DESC、ASC。默认为:DESC。',
'type' => 'string',
'required' => false,
'example' => 'DESC',
],
],
[
'name' => 'SearchMode',
'in' => 'query',
'schema' => [
'description' => '搜索模式,取值:**LIKE/EXACT/ADVANCED/COMBINATION。**'."\n"
.'- 填入LIKE或EXACT时,请使用KeyWord参数。(传入RRKeyWord、TypeKeyWord、ValueKeyWord、Type、Line、Status参数无效)'."\n"
.'- 填入ADVANCED时,请使用RRKeyWord、TypeKeyWord、ValueKeyWord、Type、Line、Status,其中RRKeyWord、ValueKeyWord为模糊匹配'."\n"
.'- 填入COMBINATION,请使用RRKeyWord、TypeKeyWord、ValueKeyWord、Type、Line、Status参数,所有参数均为精确匹配。'."\n"
.'- 不传值:'."\n"
.' - keyWord传值,搜索模式取”LIKE“值。'."\n"
.' - keyWord不传值,RRKeyWord和ValueKeyWord支持模糊查询,TypeKeyWord和Type、Line、Status支持精确查询。',
'type' => 'string',
'required' => false,
'example' => 'LIKE',
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => [
'description' => '指域名分组ID'."\n"
."\n"
.'- 如不传GroupId,则在全部域名下查询。'."\n"
."\n"
.'- 如GroupId为0,则返回空数据。'."\n"
."\n"
.'- 如GroupId为-1,则在默认分组(指未设置分组的域名)下查询。'."\n"
."\n"
.'- 如GroupId为-2,则在全部域名下查询。'."\n"
."\n"
.'- 如GroupId不符合上述条件,则按GroupId查询并返回结果。'."\n"
.'可通过调用[DescribeDomainGroups ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomaingroups?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomainGroups ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomaingroups?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2****',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '解析记录类型,参见:'."\n"
."\n"
.'[解析记录类型格式](https://help.aliyun.com/document_detail/29805.html)'."\n"
.'[解析记录类型格式](https://www.alibabacloud.com/help/zh/doc-detail/29805.htm)'."\n",
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
[
'name' => 'Line',
'in' => 'query',
'schema' => [
'description' => '解析线路,默认为**default**。'."\n"
."\n"
.'参见:'."\n"
.'[解析线路枚举](https://help.aliyun.com/document_detail/29807.html)。'."\n"
."\n"
.'[解析线路枚举](https://www.alibabacloud.com/help/zh/doc-detail/29807.htm)'."\n",
'type' => 'string',
'required' => false,
'example' => 'cn_mobile_anhui',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '解析记录状态。取值:'."\n"
."\n"
.'Enable: 启用解析'."\n"
."\n"
.'Disable: 暂停解析',
'type' => 'string',
'required' => false,
'example' => 'Enable',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '解析记录总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'PageSize' => [
'description' => '本次查询获取的解析数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'DomainRecords' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Record' => [
'description' => '解析记录列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '当前的解析记录状态。',
'type' => 'string',
'example' => 'Enable',
],
'Type' => [
'description' => '记录类型。',
'type' => 'string',
'example' => 'MX',
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'example' => '备注',
],
'TTL' => [
'description' => '缓存时间设置。单位:秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '600',
],
'RecordId' => [
'description' => '解析记录ID。',
'type' => 'string',
'example' => '9*******',
],
'Priority' => [
'description' => 'mx记录的优先级。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'RR' => [
'description' => '主机记录。',
'type' => 'string',
'example' => 'www',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'Weight' => [
'description' => '负载均衡权重。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Value' => [
'description' => '记录值。',
'type' => 'string',
'example' => 'mail1.hichina.com',
],
'Line' => [
'description' => '解析线路。',
'type' => 'string',
'example' => 'default',
],
'Locked' => [
'description' => '当前解析记录锁定状态。',
'type' => 'boolean',
'example' => 'false',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1666501957000',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1676872961000',
],
'LbaStatus' => [
'description' => '是否配置了负载均衡策略。'."\n"
.'* true: 权重'."\n"
.'* false: 轮询',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
'PageNumber' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"DomainRecords\\": {\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"Enable\\",\\n \\"Type\\": \\"MX\\",\\n \\"Remark\\": \\"备注\\",\\n \\"TTL\\": 600,\\n \\"RecordId\\": \\"9*******\\",\\n \\"Priority\\": 5,\\n \\"RR\\": \\"www\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"Weight\\": 2,\\n \\"Value\\": \\"mail1.hichina.com\\",\\n \\"Line\\": \\"default\\",\\n \\"Locked\\": false,\\n \\"CreateTimestamp\\": 1666501957000,\\n \\"UpdateTimestamp\\": 1676872961000,\\n \\"LbaStatus\\": true\\n }\\n ]\\n },\\n \\"PageNumber\\": 1\\n}","type":"json"}]',
'title' => '获取解析记录列表',
'description' => '- 查询可以指定域名(DomainName)、页码(PageNumber)和每页的数量(PageSize)来获取域名的解析列表。'."\n"
.'- 查询可以指定解析记录的主机记录关键字(RRKeyWord)、解析类型关键字(TypeKeyWord)或者记录值的关键字(ValueKeyWord)来查询含有该关键字的解析列表。'."\n"
.'- 解析列表的默认排序方式是按照解析添加的时间从新到旧排序的。'."\n"
.'- 可以指定域名分组的ID(GroupId),全部域名代表所有域名、默认分组代表未设置分组的域名。',
],
'DescribeRecordLogs' => [
'summary' => '根据传入参数获取域名的解析操作日志。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsI154TB',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => [
'description' => '关键字,按照“%KeyWord%”模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:**YYYY-MM-DD**。',
'type' => 'string',
'required' => false,
'example' => '2015-12-12',
],
],
[
'name' => 'endDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:**YYYY-MM-DD**。',
'type' => 'string',
'required' => false,
'example' => '2015-12-12',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '日志列表总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'PageSize' => [
'description' => '本次查询获取的日志数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'RecordLogs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RecordLog' => [
'description' => '域名操作日志列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Action' => [
'description' => '操作行为',
'type' => 'string',
'example' => '暂停解析记录',
],
'ActionTimestamp' => [
'description' => '操作时间戳',
'type' => 'integer',
'format' => 'int64',
'example' => '134514540000',
],
'ClientIp' => [
'description' => '操作者IP',
'type' => 'string',
'example' => '192.0.2.1',
],
'Message' => [
'description' => '操作消息',
'type' => 'string',
'example' => 'MX记录 mail 默认 xxxx.top. ( TTL: 600)',
],
'ActionTime' => [
'description' => '操作时间',
'type' => 'string',
'example' => '2015-12-12T09:23Z',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"RecordLogs\\": {\\n \\"RecordLog\\": [\\n {\\n \\"Action\\": \\"暂停解析记录\\",\\n \\"ActionTimestamp\\": 134514540000,\\n \\"ClientIp\\": \\"192.0.2.1\\",\\n \\"Message\\": \\"MX记录 mail 默认 xxxx.top. ( TTL: 600)\\",\\n \\"ActionTime\\": \\"2015-12-12T09:23Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 2\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 1\\n \\n 暂停解析记录\\n 134514540000\\n 192.0.2.0\\n MX记录 mail 默认 xxxx.top. ( TTL: 600)\\n 2015-12-12T09:23Z\\n \\n","errorExample":""}]',
'title' => '获取解析记录操作日志',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeSubDomainRecords' => [
'summary' => '根据传入参数获取某个固定子域名的所有解析记录列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsQIXAM1',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.0',
],
],
[
'name' => 'SubDomain',
'in' => 'query',
'schema' => [
'description' => '`例如参数SubDomain为"a.www.example.com"为例:`'."\n"
."\n"
.'`如果参数DomainName为空,则查询域名为example.com、主机名为”a.www“的解析记录。`'."\n"
.'`如果参数DomainName为"www.example.com",则查询域名为"www.example.com"、主机名为"a"的解析记录。`'."\n"
.'`如果参数DomainName为"a.www.example.com",则查询域名为"a.www.example.com"、主机名为"@"的解析记录。`',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'a.www.example.com',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '500',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '解析记录类型。若不传值,则返回子域名对应的全部解析记录类型。'."\n"
."\n"
.'解析类型包括(不区分大小写):**A、MX、CNAME、TXT、REDIRECT_URL、FORWORD_URL、NS、AAAA、SRV**。',
'type' => 'string',
'required' => false,
'example' => 'MX',
],
],
[
'name' => 'Line',
'in' => 'query',
'schema' => [
'description' => '解析线路。',
'type' => 'string',
'required' => false,
'example' => 'default',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '解析记录总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'PageSize' => [
'description' => '本次查询获取的解析数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'DomainRecords' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Record' => [
'description' => '解析记录列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '解析记录状态。',
'type' => 'string',
'example' => 'Enable',
],
'Type' => [
'description' => '记录类型。',
'type' => 'string',
'example' => 'CNAME',
],
'Weight' => [
'description' => '解析记录的权重。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Value' => [
'description' => '记录值。',
'type' => 'string',
'example' => 'example.net',
],
'TTL' => [
'description' => '生存时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '600',
],
'Line' => [
'description' => '解析线路。',
'type' => 'string',
'example' => 'default',
],
'RecordId' => [
'description' => '解析记录ID。',
'type' => 'string',
'example' => '99******',
],
'Priority' => [
'description' => 'MX记录的优先级。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'RR' => [
'description' => '主机记录。',
'type' => 'string',
'example' => 'www',
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'Locked' => [
'description' => '解析记录锁定状态。',
'type' => 'boolean',
'example' => 'false',
],
'Remark' => [
'description' => '备注信息。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
],
],
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"DomainRecords\\": {\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"Enable\\",\\n \\"Type\\": \\"CNAME\\",\\n \\"Weight\\": 10,\\n \\"Value\\": \\"example.net\\",\\n \\"TTL\\": 600,\\n \\"Line\\": \\"default\\",\\n \\"RecordId\\": \\"99******\\",\\n \\"Priority\\": 2,\\n \\"RR\\": \\"www\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"Locked\\": false,\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n },\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 2\\n 2\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n \\n Enable\\n CNAME\\n 10\\n example.net\\n 600\\n default\\n 9999985\\n 2\\n www\\n example.com\\n false\\n \\n 1\\n","errorExample":""}]',
'title' => '获取子域名解析记录列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetTxtRecordForVerify' => [
'summary' => '生成txt记录。用于域名、子域名找回、添加子域名验证、批量找回等功能。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => 'txt验证的功能。取值:'."\n"
."\n"
.'- 添加子域验证 : ADD_SUB_DOMAIN'."\n"
.'- 其他验证:RETRIEVAL',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ADD_SUB_DOMAIN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RR' => [
'description' => '主机记录。',
'type' => 'string',
'example' => 'aliyun******',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '9CC0D642-49D4-48DE-A1A5-9F218652E4A7',
],
'DomainName' => [
'description' => '域名名称。'."\n"
."\n"
.'> 若传入为空,则不返回该字段。',
'type' => 'string',
'example' => 'example.com',
],
'Value' => [
'description' => '记录值。'."\n"
."\n"
.'> 有效期为三天。',
'type' => 'string',
'example' => 'c99419e6997f41daaa3e*****',
],
'ParentDomainName' => [
'description' => '顶级域',
'type' => 'string',
'example' => 'com',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RR\\": \\"aliyun******\\",\\n \\"RequestId\\": \\"9CC0D642-49D4-48DE-A1A5-9F218652E4A7\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"Value\\": \\"c99419e6997f41daaa3e*****\\",\\n \\"ParentDomainName\\": \\"com\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 9CC0D642-49D4-48DE-A1A5-9F218652E4A7\\r\\n example.com\\r\\n aliyunRetrieval\\r\\n c99419e6997f41daaa3eS*****\\r\\n","errorExample":""}]',
'title' => '生成txt记录',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddCustomLine' => [
'summary' => '给域名添加自定义线路。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns3O7H9R',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'LineName',
'in' => 'query',
'schema' => [
'description' => '自定义线路名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '北京线路',
],
],
[
'name' => 'IpSegment',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'IP段列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndIp' => [
'description' => 'Ip段的结束IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.254',
],
'StartIp' => [
'description' => 'IP段的开始IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.0',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'LineId' => [
'description' => '自定义线路唯一ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '5*****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'LineCode' => [
'description' => '自定义线路Code。',
'type' => 'string',
'example' => 'hra0yc-5******',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"LineId\\": 0,\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"LineCode\\": \\"hra0yc-5******\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 597\\n B57C121B-A45F-44D8-A9B2-13E5A5044195\\n hra0yc-597\\n","errorExample":""}]',
'title' => '添加自定义线路',
'description' => '每个IP段的IP地址必须满足: EndIp >=StartIp。
'."\n"
.'域名下所有自定义线路中的所有IP段,IP范围都不能交叉重叠。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteCustomLines' => [
'summary' => '通过自定义线路唯一ID批量删除自定义线路。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns3O7H9R',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'LineIds',
'in' => 'query',
'schema' => [
'description' => '自定义线路唯一ID列表,用 “,” 号隔开唯一ID。自定义线路唯一ID可通过调用[DescribeCustomLines](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describecustomlines?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'自定义线路唯一ID可通过调用[DescribeCustomLines](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describecustomlines?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1*******,2*********',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\"\\n}","errorExample":""},{"type":"xml","example":"\\n2BC218C5-F8A7-4ED8-BC04-A962CD5493B2\\n","errorExample":""}]',
'title' => '批量删除自定义线路',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateCustomLine' => [
'summary' => '通过自定义线路唯一ID编辑自定义线路。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns3O7H9R',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'LineName',
'in' => 'query',
'schema' => [
'description' => '自定义线路名称,长度限制为1-20个字符,允许包含中文、字母、数字、\'-\'、\'_\'这些字符。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '望京线路',
],
],
[
'name' => 'LineId',
'in' => 'query',
'schema' => [
'description' => '自定义线路唯一ID。可通过调用[DescribeCustomLines](~~2355671~~)获取。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1*******',
],
],
[
'name' => 'IpSegment',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'IP段列表。IP与IP之间用中横线“-”间隔; 每行一个IP段,最少1行最多50行;只有一个IP填写IP1-IP1,不同IP段不能交叉。',
'type' => 'array',
'items' => [
'description' => 'ip段列表。',
'type' => 'object',
'properties' => [
'EndIp' => [
'description' => 'IP段的结束IP。',
'type' => 'string',
'required' => false,
'example' => '2.2.XX.XX',
],
'StartIp' => [
'description' => 'IP段的开始IP。',
'type' => 'string',
'required' => false,
'example' => '1.1.XX.XX',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 500,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B57C121B-A45F-44D8-A9B2-13E5A5044195\\n","errorExample":""}]',
'title' => '编辑自定义线路',
'description' => '每个IP段的IP地址必须满足: EndIp >=StartIp。
'."\n"
.'域名下所有自定义线路中的所有IP段,IP范围都不能交叉重叠。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeCustomLine' => [
'summary' => '通过自定义线路唯一ID查询自定义线路。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns3O7H9R',
],
],
'parameters' => [
[
'name' => 'LineId',
'in' => 'query',
'schema' => [
'description' => '自定义线路唯一ID。可通过调用[DescribeCustomLines](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describecustomlines?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeCustomLines](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describecustomlines?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '5*****',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'IpSegmentList' => [
'description' => 'IP段列表。IP与IP之间用中横线“-”间隔; 每行一个IP段,最少1行最多50行;只有一个IP填写IP1-IP1,不同IP段不能交叉。',
'type' => 'array',
'items' => [
'description' => 'IP段列表。',
'type' => 'object',
'properties' => [
'EndIp' => [
'description' => 'IP段的结束IP。',
'type' => 'string',
'example' => '1.1.XX.XX',
],
'StartIp' => [
'description' => 'IP段的开始IP。',
'type' => 'string',
'example' => '1.2.XX.XX',
],
],
],
],
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'Id' => [
'description' => '自定义线路名称ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '5*******',
],
'Code' => [
'description' => '自定义线路Code。',
'type' => 'string',
'example' => 'hra0yc-*********',
],
'Name' => [
'description' => '自定义线路名称。',
'type' => 'string',
'example' => '测试线路',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"IpSegmentList\\": [\\n {\\n \\"EndIp\\": \\"1.1.XX.XX\\",\\n \\"StartIp\\": \\"1.2.XX.XX\\"\\n }\\n ],\\n \\"DomainName\\": \\"example.com\\",\\n \\"Id\\": 0,\\n \\"Code\\": \\"hra0yc-*********\\",\\n \\"Name\\": \\"测试线路\\"\\n}","errorExample":""},{"type":"xml","example":"\\ncustomline.taobao\\n598\\nhra0yc-597\\n\\n 12.2.2.3\\n 11.1.1.2\\n\\nsecLine\\nB57C121B-A45F-44D8-A9B2-13E5A5044195\\n\\n","errorExample":""}]',
'title' => '查询自定义线路',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeCustomLines' => [
'summary' => '通过域名名称查询自定义线路列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns3O7H9R',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页个数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '云解析中已存在的域名。可通过调用[DescribeDomains ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '每页个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'PageNumber' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CustomLines' => [
'description' => '自定义线路列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Code' => [
'description' => '自定义线路Code。',
'type' => 'string',
'example' => 'hra0yc-5********',
],
'Name' => [
'description' => '线路名称。',
'type' => 'string',
'example' => 'hra0yd-5********',
],
'Id' => [
'description' => '自定义线路唯一ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '5*********',
],
'IpSegmentList' => [
'description' => 'IP段列表。IP与IP之间用中横线“-”间隔; 每行一个IP段,最少1行最多50行;只有一个IP填写IP1-IP1,不同IP段不能交叉。',
'type' => 'array',
'items' => [
'description' => 'IP段列表。',
'type' => 'object',
'properties' => [
'EndIp' => [
'description' => 'IP段的结束IP。',
'type' => 'string',
'example' => '1.1.XX.XX',
],
'StartIp' => [
'description' => 'IP段的开始IP。',
'type' => 'string',
'example' => '1.2.XX.XX',
],
],
],
],
],
],
],
'TotalItems' => [
'description' => '自定义线路总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"CustomLines\\": [\\n {\\n \\"Code\\": \\"hra0yc-5********\\",\\n \\"Name\\": \\"hra0yd-5********\\",\\n \\"Id\\": 0,\\n \\"IpSegmentList\\": [\\n {\\n \\"EndIp\\": \\"1.1.XX.XX\\",\\n \\"StartIp\\": \\"1.2.XX.XX\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalItems\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n\\n hra0yd-598\\n 598\\n secLine\\n\\n1\\n2\\n39AC4D3A-3B1E-4DC7-ACDB-B1A1E6A9C59C\\n1\\n1\\n","errorExample":""}]',
'title' => '查询自定义线路列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeSupportLines' => [
'summary' => '查询云解析支持的所有线路列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '1.1.*.*',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RecordLines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RecordLine' => [
'description' => '云解析线路列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FatherCode' => [
'description' => '父线路Code,暂时不支持返回。',
'type' => 'string',
'example' => 'unicom',
],
'LineDisplayName' => [
'description' => '线路展示名称。',
'type' => 'string',
'example' => '中国联通_海南',
],
'LineCode' => [
'description' => '线路Code。',
'type' => 'string',
'example' => 'cn_unicom_hainan',
],
'LineName' => [
'description' => '子线路名称。',
'type' => 'string',
'example' => '海南',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CFDA0830-7D6E-4C13-8632-B57C7EDCF079',
],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RecordLines\\": {\\n \\"RecordLine\\": [\\n {\\n \\"FatherCode\\": \\"unicom\\",\\n \\"LineDisplayName\\": \\"中国联通_海南\\",\\n \\"LineCode\\": \\"cn_unicom_hainan\\",\\n \\"LineName\\": \\"海南\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"CFDA0830-7D6E-4C13-8632-B57C7EDCF079\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n unicom\\n 联通_山西\\n cn_unicom_shanxi\\n 山西\\n \\n CFDA0830-7D6E-4C13-8632-B57C7EDCF079\\n","errorExample":""}]',
'title' => '获取解析线路列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDNSSLBStatus' => [
'summary' => '根据传入参数开启关闭权重配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsQIXAM1',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1',
],
],
[
'name' => 'SubDomain',
'in' => 'query',
'schema' => [
'description' => '需要权重配置的子域名,其中example.com为主域名是错误参数,请使用@.example.com',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
[
'name' => 'Open',
'in' => 'query',
'schema' => [
'description' => '是否开启权重配置。取值:'."\n"
."\n"
.'- **true**(默认):开启'."\n"
.'- **false**:关闭',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'true',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '记录类型,取值范围:A、AAAA,默认为A。',
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
[
'name' => 'Line',
'in' => 'query',
'schema' => [
'description' => '解析线路:例如默认、电信、移动等',
'type' => 'string',
'required' => false,
'example' => 'telecom',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'RecordCount' => [
'description' => '符合规则的A记录数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '8',
],
'Open' => [
'description' => '权重配置的最新状态。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"RecordCount\\": 8,\\n \\"Open\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 8\\n true\\n","errorExample":""}]',
'title' => '开启关闭权重配置',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDNSSLBWeight' => [
'summary' => '根据传入参数修改解析记录的权重。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsKT3CVU',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '192.0.2.1',
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '解析记录ID。可通过调取[DescribeDomainRecords](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c4g.11186623.help-menu-search-29697.d_0)接口获取。可通过调取[DescribeDomainRecords](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomainrecords?spm=a2c63.p38356.help-menu-search-29697.d_0)接口获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '9********',
],
],
[
'name' => 'Weight',
'in' => 'query',
'schema' => [
'description' => '要修改的权重值`[1-100]`。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'RecordId' => [
'description' => '解析记录ID。',
'type' => 'string',
'example' => '9*******',
],
'Weight' => [
'description' => '修改后的权重值。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"RecordId\\": \\"9*******\\",\\n \\"Weight\\": 2\\n}","errorExample":""},{"type":"xml","example":"\\n 536E9CAD-DB30-4647-AC87-AA5CC38C5382\\n 9999985\\n 2\\n","errorExample":""}]',
'title' => '修改权重',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeBatchResultCount' => [
'summary' => '根据任务ID查询其批量操作任务的执行结果,如果任务ID为空,返回最后一次批量操作任务的执行结果。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。'."\n"
."\n"
.'> 如果TaskId不为空,返回TaskId对应任务的执行结果;如果TaskId为空,返回最后一次任务的执行结果。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1****',
],
],
[
'name' => 'BatchType',
'in' => 'query',
'schema' => [
'description' => '批量操作类型,取值:'."\n"
."\n"
.'- **DOMAIN_ADD**:批量添加域名'."\n"
.'- **DOMAIN_DEL**:批量删除域名'."\n"
.'- **RR_ADD**:批量添加解析'."\n"
.'- **RR_DEL**:批量删除解析'."\n"
.'> 为空时不做筛选',
'type' => 'string',
'required' => false,
'example' => 'DOMAIN_ADD',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态,取值:'."\n"
."\n"
.'- **-1**:无已提交的导入域名或解析任务'."\n"
.'- **0**:处理中'."\n"
.'- **1**:已完成'."\n"
.'- **2**:已失败',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'TotalCount' => [
'description' => '批量处理的记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'TaskId' => [
'description' => '最后一次任务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1******',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '75446CC1-FC9A-4595-8D96-089D73D7A63D',
],
'FailedCount' => [
'description' => '处理失败的域名或解析记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'SuccessCount' => [
'description' => '处理成功的域名或解析记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'BatchType' => [
'description' => '批量操作类型。',
'type' => 'string',
'example' => 'DOMAIN_ADD',
],
'Reason' => [
'description' => '处理失败的原因。',
'type' => 'string',
'example' => 'No match is found for the domain name specified in the file.',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": 0,\\n \\"TotalCount\\": 4,\\n \\"TaskId\\": 0,\\n \\"RequestId\\": \\"75446CC1-FC9A-4595-8D96-089D73D7A63D\\",\\n \\"FailedCount\\": 2,\\n \\"SuccessCount\\": 2,\\n \\"BatchType\\": \\"DOMAIN_ADD\\",\\n \\"Reason\\": \\"No match is found for the domain name specified in the file.\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0\\n 4\\n 123456\\n 75446CC1-FC9A-4595-8D96-089D73D7A63D\\n 2\\n 2\\n DOMAIN_ADD\\n failed_reason\\n","errorExample":""}]',
'title' => '查询某次批量操作任务的执行结果',
],
'DescribeBatchResultDetail' => [
'summary' => '查询批量处理结果的详细信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsL5Z2KT',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页码,默认值为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时每页设置的大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '20',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '8*******',
],
],
[
'name' => 'BatchType',
'in' => 'query',
'schema' => [
'description' => '批量操作类型。取值:'."\n"
."\n"
.'- **DOMAIN_ADD**:批量添加域名'."\n"
.'- **DOMAIN_DEL**:批量删除域名'."\n"
.'- **RR_ADD**:批量添加解析'."\n"
.'- **RR_DEL**:批量删除解析'."\n"
.'> 为空时不做筛选',
'type' => 'string',
'required' => false,
'example' => 'DOMAIN_ADD',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '获取指定状态结果详情,不传入则获取所有。',
'type' => 'string',
'required' => false,
'example' => 'SUCCESS',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '记录总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'BatchResultDetails' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'BatchResultDetail' => [
'description' => '批量处理结果的详细信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '执行结果。**true**代表成功,**false**代表失败。',
'type' => 'boolean',
'example' => 'true',
],
'Type' => [
'description' => '域名解析类型。',
'type' => 'string',
'example' => 'A',
],
'Domain' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'Remark' => [
'description' => '解析记录备注。',
'type' => 'string',
'example' => 'remark',
],
'RecordId' => [
'description' => '解析记录的ID。',
'type' => 'string',
'example' => '1*********',
],
'Rr' => [
'description' => '主机记录。',
'type' => 'string',
'example' => 'www',
],
'Priority' => [
'description' => 'MX优先级。',
'type' => 'string',
'example' => '10',
],
'RrStatus' => [
'description' => '解析记录状态。',
'type' => 'string',
'example' => '暂停',
],
'OperateDateStr' => [
'description' => '处理时间。',
'type' => 'string',
'example' => '2019-08-22 18:02:58',
],
'NewValue' => [
'description' => '新的记录值。',
'type' => 'string',
'example' => '192.0.2.1',
],
'Value' => [
'description' => '记录值。',
'type' => 'string',
'example' => '198.51.100.1',
],
'Ttl' => [
'description' => '生效时间。',
'type' => 'string',
'example' => '600',
],
'BatchType' => [
'description' => '批量操作类型。',
'type' => 'string',
'example' => 'DOMAIN_ADD',
],
'Line' => [
'description' => '线路代码。',
'type' => 'string',
'example' => 'default',
],
'NewRr' => [
'description' => '新的主机记录。',
'type' => 'string',
'example' => 'demo-batch-7',
],
'Reason' => [
'description' => '执行失败的原因。',
'type' => 'string',
'example' => '内部异常',
],
],
],
],
],
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '75446CC1-FC9A-4595-8D96-089D73D7A63D',
],
'PageNumber' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 1,\\n \\"BatchResultDetails\\": {\\n \\"BatchResultDetail\\": [\\n {\\n \\"Status\\": true,\\n \\"Type\\": \\"A\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"Remark\\": \\"remark\\",\\n \\"RecordId\\": \\"1*********\\",\\n \\"Rr\\": \\"www\\",\\n \\"Priority\\": \\"10\\",\\n \\"RrStatus\\": \\"暂停\\",\\n \\"OperateDateStr\\": \\"2019-08-22 18:02:58\\",\\n \\"NewValue\\": \\"192.0.2.1\\",\\n \\"Value\\": \\"198.51.100.1\\",\\n \\"Ttl\\": \\"600\\",\\n \\"BatchType\\": \\"DOMAIN_ADD\\",\\n \\"Line\\": \\"default\\",\\n \\"NewRr\\": \\"demo-batch-7\\",\\n \\"Reason\\": \\"内部异常\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"75446CC1-FC9A-4595-8D96-089D73D7A63D\\",\\n \\"PageNumber\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n \\n true\\n A\\n example.com\\n remark\\n 123456789\\n www\\n 10\\n 暂停\\n 2019-08-22 18:02:58\\n 192.0.2.254\\n 192.0.2.0\\n 600\\n DOMAIN_ADD\\n default\\n demo-batch-7\\n 内部异常\\n \\n 10\\n 75446CC1-FC9A-4595-8D96-089D73D7A63D\\n 1\\n","errorExample":""}]',
'title' => '查询批量处理结果的详细信息',
'description' => '**前提条件:请在批量任务执行完成后,再调用此接口。**',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeTags' => [
'summary' => '查询已有标签。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。取值:'."\n"
.'- **DOMAIN**:域名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOMAIN',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页数,默认值:200。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '200',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '总计数。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'PageSize' => [
'description' => '分页数,默认值:200。',
'type' => 'integer',
'format' => 'int64',
'example' => '200',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '89184F33-48A1-4401-9C0F-40E45DB091AB',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Tags' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'abc',
],
'Values' => [
'description' => '标签值列表。',
'type' => 'array',
'items' => [
'description' => '标签值。',
'type' => 'string',
'example' => '11111',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TotalCount\\": 5,\\n \\"PageSize\\": 200,\\n \\"RequestId\\": \\"89184F33-48A1-4401-9C0F-40E45DB091AB\\",\\n \\"PageNumber\\": 1,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"abc\\",\\n \\"Values\\": [\\n \\"11111\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"6\\n89184F33-48A1-4401-9C0F-40E45DB091AB\\n1\\n1\\n\\n 1\\n a\\n\\n\\n 123\\n 123\\n\\n\\n 001\\n abc\\n\\n\\n 1111\\n 1111\\n\\n\\n abcd\\n abcd\\n\\n\\n testtag\\n","errorExample":""}]',
'title' => '查询已有标签列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListTagResources' => [
'summary' => '按照标签查询资源。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。取值:'."\n"
.'- **DOMAIN**:域名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOMAIN',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '下一个查询开始Token。',
'type' => 'string',
'required' => false,
'example' => '4698691',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签键值对数组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'abcd',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'abcd',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源id。',
'type' => 'array',
'items' => [
'description' => '域名,当Tag数组传空值时,ResourceId为必传。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
'required' => false,
'maxItems' => 51,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => [
'description' => '下一个查询开始token,nexttoken为空说明没有下一个。',
'type' => 'string',
'example' => '4698691',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '61092C8D-6AEB-4310-B74D-C632F89BF4FB',
],
'TagResources' => [
'description' => '由资源及其标签组成的集合,包含了资源ID、资源类型和标签键值等信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceType' => [
'description' => '资源类型。取值:DOMAIN。',
'type' => 'string',
'example' => 'DOMAIN',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'abcd',
],
'ResourceId' => [
'description' => '资源ID。',
'type' => 'string',
'example' => 'example.com',
],
'TagKey' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'abcd',
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"4698691\\",\\n \\"RequestId\\": \\"61092C8D-6AEB-4310-B74D-C632F89BF4FB\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceType\\": \\"DOMAIN\\",\\n \\"TagValue\\": \\"abcd\\",\\n \\"ResourceId\\": \\"example.com\\",\\n \\"TagKey\\": \\"abcd\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '标签查询资源',
'description' => '- 请求中至少指定参数ResourceId.N或Tag.N(Tag.N.Key与Tag.N.Value),以确定检索对象。'."\n"
.'- Tag.N是资源的标签,由一个键值对组成。仅指定Tag.N.Key时,则返回该标签键关联的所有标签值。仅指定Tag.N.Value会报错。'."\n"
.'- 如果您同时指定Tag.N和ResourceId.N筛选标签,则ResourceId.N必须满足所有输入的标签键值对。'."\n"
.'- 如果您同时指定多个标签键值对,返回结果为同时包含被指定的多个键值对的资源。',
],
'TagResources' => [
'summary' => '通过进行添加、修改资源的标签。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。取值:'."\n"
.'- **DOMAIN**:域名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOMAIN',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签键值对数组。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。不能以`acs:`或`aliyun`开头,长度不能超过20字节。',
'type' => 'string',
'required' => false,
'example' => 'abcd',
],
'Value' => [
'description' => '标签值。长度不能超过20字节。',
'type' => 'string',
'required' => false,
'example' => 'abcd',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 21,
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源id。',
'type' => 'array',
'items' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com'."\n",
],
'required' => true,
'example' => 'dns-example.com',
'maxItems' => 51,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '635B0CCD-15A7-48C9-B4D6-628FF57FF4B8',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"635B0CCD-15A7-48C9-B4D6-628FF57FF4B8\\"\\n}","errorExample":""},{"type":"xml","example":"635B0CCD-15A7-48C9-B4D6-628FF57FF4B8","errorExample":""}]',
'title' => '添加修改资源标签',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UntagResources' => [
'summary' => '进行删除资源的标签。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。取值:'."\n"
.'- **DOMAIN**:域名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'DOMAIN',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'description' => '是否全部删除,默认是false。只针对tagkey数组为空时有效。取值范围:-true-false',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '资源id。',
'type' => 'array',
'items' => [
'description' => '域名,当Tag数组传空值时,ResourceId为必传。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签数组。',
'type' => 'array',
'items' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'abcd',
],
'required' => false,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求标识。',
'type' => 'string',
'example' => 'F152A869-DF77-4DF1-9A00-4E06978FE6A1',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F152A869-DF77-4DF1-9A00-4E06978FE6A1\\"\\n}","type":"json"}]',
'title' => '删除资源标签',
],
'MoveDomainResourceGroup' => [
'summary' => '更换资源组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns7SH50L',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '新资源组ID。'."\n"
."\n"
.'您可以通过[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups?)查看资源组ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'rg-aek*******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => 'C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB\\"\\n}","errorExample":""},{"type":"xml","example":"C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB","errorExample":""}]',
'title' => '更换域名资源组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddDnsCacheDomain' => [
'summary' => '根据传入参数添加 DNS 权威代理域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsB25P4Z',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文'."\n"
.'默认为**zh**',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '权威代理域名实例ID。可通过调用[ListCloudGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[ListCloudGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'dns-cn-*****',
],
],
[
'name' => 'CacheTtlMin',
'in' => 'query',
'schema' => [
'description' => '回源缓存数据TTL(最小值),取值范围为30 - 86400',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '86400',
'minimum' => '30',
'example' => '30',
],
],
[
'name' => 'CacheTtlMax',
'in' => 'query',
'schema' => [
'description' => '回源缓存数据TTL(最大值),取值范围为30 - 86400',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '86400',
'minimum' => '30',
'example' => '86400',
],
],
[
'name' => 'SourceProtocol',
'in' => 'query',
'schema' => [
'description' => '回源协议,TCP、UDP。默认值为UDP',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'UDP',
],
],
[
'name' => 'SourceEdns',
'in' => 'query',
'schema' => [
'description' => '源站是否支持edns。NOT_SUPPORT:不支持,SUPPORT:支持',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'SUPPORT',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'SourceDnsServer',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '源站DNS服务器列表,最多支持10条记录',
'type' => 'array',
'items' => [
'description' => '源站DNS服务器',
'type' => 'object',
'properties' => [
'Host' => [
'description' => '源站服务器的域名或IP地址',
'type' => 'string',
'required' => true,
'example' => '192.168.0.1',
],
'Port' => [
'description' => '源站DNS服务器端口',
'type' => 'string',
'required' => true,
'example' => '53',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-XXXXXXX',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-XXXXXXX\\"\\n}","type":"json"}]',
'title' => '添加 DNS 权威代理域名',
],
'UpdateDnsCacheDomain' => [
'summary' => '根据传入参数更新 DNS 权威代理域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsB25P4Z',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文'."\n"
.'默认为**zh**',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '权威代理域名实例ID。可通过调用[ListCloudGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[ListCloudGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-listcloudgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'dns-sg-l*******',
],
],
[
'name' => 'CacheTtlMin',
'in' => 'query',
'schema' => [
'description' => '回源缓存数据TTL(最小值),取值范围为30 - 86400',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '86400',
'minimum' => '30',
'example' => '30',
],
],
[
'name' => 'CacheTtlMax',
'in' => 'query',
'schema' => [
'description' => '回源缓存数据TTL(最大值),取值范围为30 - 86400',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '86400',
'minimum' => '30',
'example' => '86400',
],
],
[
'name' => 'SourceProtocol',
'in' => 'query',
'schema' => [
'description' => '回源协议,TCP、UDP,默认值为UDP',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'UDP',
],
],
[
'name' => 'SourceEdns',
'in' => 'query',
'schema' => [
'description' => '源站是否支持edns。'."\n"
.'NOT_SUPPORT:不支持,SUPPORT:支持',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'SUPPORT',
],
],
[
'name' => 'SourceDnsServer',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '源站DNS服务器列表,最多支持添加10条记录',
'type' => 'array',
'items' => [
'description' => '源站DNS服务器',
'type' => 'object',
'properties' => [
'Host' => [
'description' => '源站服务器的域名或IP地址',
'type' => 'string',
'required' => false,
'example' => '192.168.0.1'."\n",
],
'Port' => [
'description' => '源站DNS服务器端口',
'type' => 'string',
'required' => false,
'example' => '53',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","type":"json"}]',
'title' => '更新 DNS 权威代理域名',
],
'UpdateDnsCacheDomainRemark' => [
'summary' => '更新目标域名的DNS 权威代理域名备注。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsB25P4Z',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,取值:'."\n"
."\n"
.'- **zh**:中文'."\n"
."\n"
.'- **en**:英文'."\n"
."\n"
.'默认为**zh**',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注,长度限制50个字符,只可包含中英文数字以及 . 、_、- '."\n"
."\n"
.'为空时删除原有备注',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","type":"json"}]',
'title' => '更新 DNS 权威代理域名备注',
],
'DeleteDnsCacheDomain' => [
'summary' => '删除指定的DNS权威代理域名。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsB25P4Z',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文'."\n"
.'默认为**zh**',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。可通过调用[DescribeDomains](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c4g.11186623.help-menu-search-29697.d_0)获取'."\n"
.'可通过调用[DescribeDomains](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describedomains?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","type":"json"}]',
'title' => '删除 DNS 权威代理域名',
],
'DescribeDnsCacheDomains' => [
'summary' => '根据传入参数查询该用户的权威代理域名列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsB25P4Z',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文'."\n"
.'默认为**zh**',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '关键字,按照”%Keyword%”模式搜索,不区分大小写',
'type' => 'string',
'required' => false,
'example' => 'a',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Domains' => [
'description' => '本次获取的域名列表。',
'type' => 'array',
'items' => [
'description' => '域名名称',
'type' => 'object',
'properties' => [
'SourceProtocol' => [
'description' => '回源协议,TCP、UDP。默认值为UDP',
'type' => 'string',
'example' => 'UDP',
],
'UpdateTime' => [
'description' => '最后更新时间',
'type' => 'string',
'example' => '2023-05-22T03:40Z',
],
'Remark' => [
'description' => '备注',
'type' => 'string',
'example' => 'remark',
],
'ExpireTime' => [
'description' => '实例过期时间',
'type' => 'string',
'example' => '2022-12-02T16:00Z',
],
'CreateTime' => [
'description' => '添加时间',
'type' => 'string',
'example' => '2022-10-17T06:13Z',
],
'InstanceId' => [
'description' => '权威代理域名实例ID',
'type' => 'string',
'example' => 'i-7***',
],
'SourceEdns' => [
'description' => '源站是否支持edns。NOT_SUPPORT:不支持,SUPPORT:支持',
'type' => 'string',
'example' => 'SUPPORT',
],
'DomainName' => [
'description' => '权威代理域名名称',
'type' => 'string',
'example' => 'example.com',
],
'DomainId' => [
'description' => '权威代理域名ID',
'type' => 'string',
'example' => '00efd71a-770e-*****************',
],
'UpdateTimestamp' => [
'description' => '最后更新时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1671690491000',
],
'ExpireTimestamp' => [
'description' => '实例过期时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1692374400000',
],
'CacheTtlMax' => [
'description' => '回源缓存数据TTL(最大值),取值范围为30 - 86400',
'type' => 'integer',
'format' => 'int32',
'example' => '86400',
],
'CacheTtlMin' => [
'description' => '回源缓存数据TTL(最小值),取值范围为30 - 86400',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'VersionCode' => [
'description' => '云解析版本Code',
'type' => 'string',
'example' => 'ultimate',
],
'SourceDnsServers' => [
'description' => '源站DNS服务器列表',
'type' => 'array',
'items' => [
'description' => '源站DNS服务器',
'type' => 'object',
'properties' => [
'Host' => [
'description' => '源站服务器的域名或IP地址',
'type' => 'string',
'example' => 'ns8.alidns.com',
],
'Port' => [
'description' => '源站DNS服务器端口',
'type' => 'string',
'example' => '53',
],
],
],
],
'CreateTimestamp' => [
'description' => '添加时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1660546144000',
],
],
],
],
'TotalCount' => [
'description' => '域名列表总数',
'type' => 'integer',
'format' => 'int64',
'example' => '3',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => '57121A9C-CDCF-541F-AD39-275D89099420',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Domains\\": [\\n {\\n \\"SourceProtocol\\": \\"UDP\\",\\n \\"UpdateTime\\": \\"2023-05-22T03:40Z\\",\\n \\"Remark\\": \\"remark\\",\\n \\"ExpireTime\\": \\"2022-12-02T16:00Z\\",\\n \\"CreateTime\\": \\"2022-10-17T06:13Z\\",\\n \\"InstanceId\\": \\"i-7***\\",\\n \\"SourceEdns\\": \\"SUPPORT\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"DomainId\\": \\"00efd71a-770e-*****************\\",\\n \\"UpdateTimestamp\\": 1671690491000,\\n \\"ExpireTimestamp\\": 1692374400000,\\n \\"CacheTtlMax\\": 86400,\\n \\"CacheTtlMin\\": 30,\\n \\"VersionCode\\": \\"ultimate\\",\\n \\"SourceDnsServers\\": [\\n {\\n \\"Host\\": \\"ns8.alidns.com\\",\\n \\"Port\\": \\"53\\"\\n }\\n ],\\n \\"CreateTimestamp\\": 1660546144000\\n }\\n ],\\n \\"TotalCount\\": 3,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"57121A9C-CDCF-541F-AD39-275D89099420\\",\\n \\"PageNumber\\": 1\\n}","type":"json"}]',
'title' => '获取 DNS 权威代理域名',
],
'CreateCloudGtmInstanceConfig' => [
'summary' => '创建gtm实例配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => [
'FEATUREdnsBCOB1Q',
],
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US:英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24**22',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => '调度实例id',
'description' => '全局流量管理3.0实例ID,唯一标识产品实例。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-jmp3qnw**03',
],
],
[
'name' => 'ScheduleZoneMode',
'in' => 'query',
'schema' => [
'title' => '接入zone分配模式',
'description' => '接入域名配置模式:'."\n"
."\n"
.'- sys_assign:系统分配(此模式已不支持)'."\n"
."\n"
.'- custom:自定义,用户需选择实例所在账号下的域名进行关联,并输入主机记录以生成接入域名',
'type' => 'string',
'required' => false,
'example' => 'custom',
],
],
[
'name' => 'ScheduleZoneName',
'in' => 'query',
'schema' => [
'title' => 'zone名称',
'description' => 'zone名称,即GTM接入域名的父Zone。一般为GTM实例所在账号下,在云解析DNS控制台的托管域名,支持主域和子域。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'ScheduleHostname',
'in' => 'query',
'schema' => [
'title' => '主机记录',
'description' => 'GTM接入域名的主机记录。',
'type' => 'string',
'required' => false,
'example' => 'www',
],
],
[
'name' => 'ScheduleRrType',
'in' => 'query',
'schema' => [
'title' => '调度解析记录类型',
'description' => '接入域名的解析记录类型:'."\n"
."\n"
.'- A:IPv4地址'."\n"
."\n"
.'- AAAA:IPv6地址'."\n"
."\n"
.'- CNAME:域名',
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => [
'title' => '调度调度实例的TTL',
'description' => '全局TTL,单位是秒。接入域名解析到地址池中地址的TTL值,影响解析记录在运营商LocalDNS中的缓存时间,支持自定义TTL值。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'description' => '域名实例的启用状态:'."\n"
."\n"
.'- enable:启用状态,GTM实例智能调度策略生效;'."\n"
."\n"
.'- disable:禁用状态,GTM实例智能调度策略不可用;',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'title' => '实例配置的付费类型,不填默认为预付费',
'description' => '实例配置的付费类型:'."\n"
."\n"
.'- 预付费:prepay (传入空值默认是prepay)'."\n"
."\n"
.'- 后付费:postpay',
'type' => 'string',
'required' => false,
'example' => 'postpay',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
'ConfigId' => [
'description' => '域名实例配置id,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。',
'type' => 'boolean',
'example' => 'config-000**1',
],
'InstanceId' => [
'title' => '返回实例Id',
'description' => '返回实例Id',
'type' => 'string',
'example' => 'gtm-cn-xxxxx',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Success\\": true,\\n \\"ConfigId\\": true,\\n \\"InstanceId\\": \\"gtm-cn-xxxxx\\"\\n}","type":"json"}]',
'title' => '创建域名实例配置',
],
'UpdateCloudGtmInstanceName' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US:英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24**22',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => 'GTM实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-jmp3qnw**03',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '实例名称,不可传入空值。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
'Success' => [
'description' => '本次修改实例名称操作是否成功:'."\n"
."\n"
.'- true:成功'."\n"
."\n"
.'- false:失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改实例名称',
],
'SetCloudGtmInstanceConfigLogSwitch' => [
'summary' => '按需启用或停用全局流量管理(GTM)实例的流量分析功能。'."\n"
.'启用后,即可查看该接入域名的解析日志、统计报表,并享受基于异常指标(如解析成功率、QPS 突变等)的智能告警服务,全面提升 GTM 解析的可观测性与运维效率。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsXET43R',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。'."\n"
."\n"
.'> 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'F4D7C841-A1C9-50B4-88B7-F5****',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '全局流量管理GTM 3.0实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3h****',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。'."\n"
.'调用[ListCloudGtmInstanceConfigs](~~2797349~~) 接口可查询域名实例对应的 ConfigId 值。',
'type' => 'string',
'required' => true,
'example' => 'Config-000****',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '实例启用流量分析的状态:'."\n"
.'- enable:开启,设置启用当前接入域名的流量分析;'."\n"
.'- disable:关闭,设置关闭当前接入域名的流量分析;'."\n",
'type' => 'string',
'required' => true,
'example' => 'enable'."\n"
.'disable',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '启用/禁用全局流量管理流量分析',
],
'DescribeCloudGtmInstanceConfigFullInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回信息的语言类型:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '全局流量管理3.0实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3h****',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '域名实例配置ID。相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。'."\n"
."\n"
.'调用[ListCloudGtmInstanceConfigs](~~2797349~~)接口可查询域名实例对应的ConfigId值。',
'type' => 'string',
'required' => false,
'example' => 'Config-000****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
'InstanceId' => [
'title' => '实例id',
'description' => '全局流量管理3.0实例ID。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3h****',
],
'ConfigId' => [
'title' => '实例id',
'description' => '域名实例配置ID。'."\n"
.'相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。',
'type' => 'string',
'example' => 'Config-000****',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '实例创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'VersionCode' => [
'title' => '版本code',
'description' => '全局流量管理3.0实例版本:'."\n"
."\n"
.'- standard:标准版'."\n"
."\n"
.'- ultimate:旗舰版',
'type' => 'string',
'example' => 'ultimate',
],
'CommodityCode' => [
'title' => '商品code',
'description' => '商品编码:'."\n"
."\n"
.'- dns_gtm_public_cn:中国站商品编码。'."\n"
."\n"
.'- dns_gtm_public_intl:国际站商品编码。',
'type' => 'string',
'example' => 'dns_gtm_public_cn',
],
'InstanceName' => [
'title' => '调度实例名称',
'description' => '调度实例名称。',
'type' => 'string',
'example' => 'test',
],
'ScheduleZoneMode' => [
'title' => '接入zone分配模式',
'description' => '接入域名分配模式:'."\n"
."\n"
.'- custom:自定义接入域名,用户自定义主机记录,并关联GTM实例所在账号下的主域或子域,生成接入域名。'."\n"
."\n"
.'- sys_assign:系统默认分配接入域名,本功能已经不支持,请勿选择此模式。',
'type' => 'string',
'example' => 'custom',
],
'ScheduleZoneName' => [
'title' => 'zone名称',
'description' => 'GTM接入域名的主域(example.com)或子域(a.example.com)。一般为GTM实例所在账号下,在云解析DNS控制台权威解析中托管的域名。',
'type' => 'string',
'example' => 'example.com',
],
'ScheduleHostname' => [
'title' => '主机记录',
'description' => 'GTM接入域名的主机记录。',
'type' => 'string',
'example' => 'www',
],
'ScheduleDomainName' => [
'title' => '域名,主机记录+zoneNamne',
'description' => 'GTM接入域名。格式为接入域名主机记录(ScheduleHostname参数值)+主域或子域(ScheduleZoneName参数值)',
'type' => 'string',
'example' => 'www.example.com',
],
'ScheduleRrType' => [
'title' => '调度解析记录类型',
'description' => '调度域名的解析记录类型:'."\n"
."\n"
.'- A:IPv4地址'."\n"
."\n"
.'- AAAA:IPv6地址'."\n"
."\n"
.'- CNAME:域名',
'type' => 'string',
'example' => 'A',
],
'Ttl' => [
'title' => '调度调度实例的TTL',
'description' => '全局TTL(单位:秒),接入域名解析到地址池中地址的TTL值,影响解析记录在运营商LocalDNS中的缓存时间,支持自定义TTL值。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'AddressPoolLbStrategy' => [
'title' => '地址池的负载均衡策略',
'description' => '地址池之间的负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址池。并且每次对于所有地址池进行轮转排序;'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。若顺序号较小的地址池不可用时,返回下一个序号较小的地址池。'."\n"
."\n"
.'- weight:权重,支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址池,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'title' => '顺序负载策略模式(抢占式、非抢占式)',
'description' => '地址池间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址池。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址池。',
'type' => 'string',
'example' => 'preemptive',
],
'AvailableStatus' => [
'description' => '域名实例服务可用状态:'."\n"
."\n"
.'- available:可用,域名**启用**且健康状态为**正常**,接入域名的服务可用状态为**可用**。'."\n"
."\n"
.'- unavailable:不可用,域名**禁用**或健康状态为**异常**,接入域名的服务可用状态为**不可用**。',
'type' => 'string',
'example' => 'available',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '域名实例的启用状态:'."\n"
."\n"
.'- enable:启用状态,GTM实例智能调度策略生效。'."\n"
."\n"
.'- disable:禁用状态,GTM实例智能调度策略不可用。',
'type' => 'string',
'example' => 'enable',
],
'HealthStatus' => [
'title' => '监控状态',
'description' => '域名实例健康状态:'."\n"
."\n"
.'- ok:正常,接入域名引用的所有地址池全部可用。'."\n"
."\n"
.'- ok_alert:警告,接入域名引用的所有地址池部分不可用。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,接入域名引用的所有地址池全部不可用。此时,使用实例所引用的顺序号较小的非空地址池中的地址进行兜底解析,尽可能帮助客户端获得解析结果。',
'type' => 'string',
'example' => 'ok',
],
'AlertGroup' => [
'title' => '告警通知组',
'description' => '告警通知组。',
'type' => 'string',
'example' => '[\\"云账号报警联系人\\"]',
],
'AlertConfig' => [
'title' => '告警通知配置',
'description' => '告警通知配置。',
'type' => 'string',
'example' => '[{\\"NoticeType\\":\\"addr_alert\\",\\"SmsNotice\\":true,\\"EmailNotice\\":true,\\"DingtalkNotice\\":true},{\\"NoticeType\\":\\"addr_resume\\",\\"SmsNotice\\":true,\\"EmailNotice\\":true,\\"DingtalkNotice\\":true},{\\"NoticeType\\":\\"addr_pool_unavailable\\",\\"SmsNotice\\":true,\\"EmailNotice\\":true,\\"DingtalkNotice\\":true},{\\"NoticeType\\":\\"addr_pool_available\\",\\"SmsNotice\\":true,\\"EmailNotice\\":true,\\"DingtalkNotice\\":true}]"',
],
'Remark' => [
'title' => '备注',
'description' => '域名实例配置的备注。',
'type' => 'string',
'example' => 'test',
],
'AddressPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddressPool' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'description' => '地址池配置信息。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'description' => '地址池创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '地址池创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'description' => '地址池最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '地址池最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357'."\n",
],
'AddressPoolId' => [
'title' => '地址池Id',
'description' => '地址池ID,地址池的唯一标识码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
'WeightValue' => [
'title' => '权重值',
'description' => '权重值(1-100之间的整数,包括1和100),支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SerialNumber' => [
'title' => '序号',
'description' => '顺序号,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestSource' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestSource' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'description' => '请求来源,是指解析请求的来源,GTM是根据终端所用LocalDNS的出口IP进行调度。若LocalDNS支持ECS (edns-client-subnet),也可以根据访问终端的IP进行智能调度。',
'type' => 'string',
'example' => '["default"]',
],
],
],
],
'AddressPoolName' => [
'title' => '地址池名称',
'description' => '地址池名称。',
'type' => 'string',
'example' => 'AddressPool-1',
],
'AddressPoolType' => [
'title' => '地址池类型ipv4、ipv6、domain',
'description' => '地址池类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'example' => 'IPv4',
],
'AddressLbStrategy' => [
'title' => '地址负载策略',
'description' => '地址池中地址间负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址。并且每次对于所有地址进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址(顺序号标识地址返回的优先级,越小优先级越高)。若顺序号较小的地址不可用时,返回下一个序号较小的地址。'."\n"
."\n"
.'- weight:权重,支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'title' => '顺序负载策略模式(抢占式、非抢占式)',
'description' => '地址间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址。',
'type' => 'string',
'example' => 'preemptive',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '地址池启用状态:'."\n"
."\n"
.'- enable:启用状态。'."\n"
.'- disable:禁用状态。',
'type' => 'string',
'example' => 'enable',
],
'HealthJudgement' => [
'title' => '健康判定',
'description' => '地址池健康状态判定条件:'."\n"
."\n"
.'- any_ok:地址池内至少1个地址是可用地址。'."\n"
."\n"
.'- p30_ok:地址池内至少30%地址是可用地址。'."\n"
."\n"
.'- p50_ok:地址池内至少50%地址是可用地址。'."\n"
."\n"
.'- p70_ok:地址池内至少70%地址是可用地址。'."\n"
."\n"
.'- all_ok:地址池内地址全部可用。',
'type' => 'string',
'example' => 'any_ok',
],
'HealthStatus' => [
'title' => '健康状态',
'description' => '地址池健康状态:'."\n"
."\n"
.'- ok:正常,地址池引用的所有地址全部可用。'."\n"
."\n"
.'- ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析'."\n"
."\n"
.'- exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。',
'type' => 'string',
'example' => 'ok',
],
'AvailableStatus' => [
'title' => '可用性状态',
'description' => '地址池可用性状态:'."\n"
."\n"
.'- available:可用。'."\n"
."\n"
.'- unavailable:不可用。',
'type' => 'string',
'example' => 'available',
],
'Addresses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Address' => [
'description' => '地址列表。',
'type' => 'array',
'items' => [
'description' => '地址信息。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '地址创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '地址创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '地址最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357'."\n",
],
'AddressId' => [
'title' => '地址 ID',
'description' => '地址ID,唯一标识地址。',
'type' => 'string',
'example' => 'addr-89564712295703****',
],
'WeightValue' => [
'title' => '权重',
'description' => '权重值(1-100内的整数,包括1和100),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SerialNumber' => [
'title' => '序号',
'description' => '顺序号,标识地址返回的优先级,越小优先级越高。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestSource' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestSource' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'description' => '请求来源,是指解析请求的来源,GTM是根据终端所用LocalDNS的出口IP进行调度。若LocalDNS支持ECS (edns-client-subnet),也可以根据访问终端的IP进行智能调度。',
'type' => 'string',
'example' => '["default"]',
],
],
],
],
'Name' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'example' => 'Address-1',
],
'Type' => [
'title' => '地址类型',
'description' => '地址类型:'."\n"
."\n"
.'- IPv4: IPv4地址'."\n"
."\n"
.'- IPv6: IPv6地址'."\n"
."\n"
.'- domain:域名',
'type' => 'string',
'example' => 'IPv4',
],
'Address' => [
'title' => '地址',
'description' => 'IP地址或者域名。',
'type' => 'string',
'example' => '223.5.XX.XX',
],
'AttributeInfo' => [
'title' => '地址归属信息',
'description' => '地址归属信息,当前版本不支持返回此参数。',
'type' => 'string',
'example' => '当前版本不支持返回此参数。',
],
'Remark' => [
'title' => '备注',
'description' => '地址备注信息。',
'type' => 'string',
'example' => 'test',
],
'EnableStatus' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '地址启用状态,表示地址当前是否可用:'."\n"
."\n"
.'- enable:启用状态。'."\n"
."\n"
.'- disable:禁用状态。',
'type' => 'string',
'example' => 'enable',
],
'AvailableMode' => [
'title' => '可用状态设置模式',
'description' => '地址探测异常切换方式:'."\n"
."\n"
.'- auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。'."\n"
."\n"
.'- manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。',
'type' => 'string',
'example' => 'auto',
],
'ManualAvailableStatus' => [
'title' => '手动设置的可用状态',
'description' => '当地址探测异常切换模式为manual时,地址设置的可用状态:'."\n"
."\n"
.'- available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'- unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'example' => 'available',
],
'AvailableStatus' => [
'title' => '地址可用状态',
'description' => '地址可用状态:'."\n"
."\n"
.'- available:地址可用。'."\n"
."\n"
.'- unavailable:地址不可用。',
'type' => 'string',
'example' => 'available',
],
'HealthStatus' => [
'title' => '地址的健康状态:',
'description' => '地址健康探测状态:'."\n"
."\n"
.'- ok:地址引用的健康探测模板探测任务全部正常。'."\n"
."\n"
.'- ok_alert:地址引用的健康探测模板探测任务部分异常,但地址判定为正常状态。'."\n"
."\n"
.'- ok_no_monitor:地址没有引用任何健康探测模板,状态正常。'."\n"
."\n"
.'- exceptional:地址引用的健康探测模板探测任务部分或全部异常,且地址判定为异常状态。',
'type' => 'string',
'example' => 'ok',
],
'HealthJudgement' => [
'title' => '地址健康状态判定为ok 的方式:',
'description' => '地址健康状态判定条件:'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'example' => 'any_ok',
],
'SeqNonPreemptiveSchedule' => [
'description' => '是否是顺序(非抢占)模式调度对象,针对于融合云纳管场景:'."\n"
."\n"
.'- true:是'."\n"
."\n"
.'- false:不是',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
'SeqNonPreemptiveSchedule' => [
'description' => '是否是顺序(非抢占)模式调度对象,针对于融合云纳管场景:'."\n"
."\n"
.'- true:是'."\n"
."\n"
.'- false:不是',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\",\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3h****\\",\\n \\"ConfigId\\": \\"Config-000****\\",\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"VersionCode\\": \\"ultimate\\",\\n \\"CommodityCode\\": \\"dns_gtm_public_cn\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"ScheduleZoneMode\\": \\"custom\\",\\n \\"ScheduleZoneName\\": \\"example.com\\",\\n \\"ScheduleHostname\\": \\"www\\",\\n \\"ScheduleDomainName\\": \\"www.example.com\\",\\n \\"ScheduleRrType\\": \\"A\\",\\n \\"Ttl\\": 60,\\n \\"AddressPoolLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"AlertGroup\\": \\"[\\\\\\\\\\\\\\"云账号报警联系人\\\\\\\\\\\\\\"]\\",\\n \\"AlertConfig\\": \\"[{\\\\\\\\\\\\\\"NoticeType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"addr_alert\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SmsNotice\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"EmailNotice\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"DingtalkNotice\\\\\\\\\\\\\\":true},{\\\\\\\\\\\\\\"NoticeType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"addr_resume\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SmsNotice\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"EmailNotice\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"DingtalkNotice\\\\\\\\\\\\\\":true},{\\\\\\\\\\\\\\"NoticeType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"addr_pool_unavailable\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SmsNotice\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"EmailNotice\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"DingtalkNotice\\\\\\\\\\\\\\":true},{\\\\\\\\\\\\\\"NoticeType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"addr_pool_available\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SmsNotice\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"EmailNotice\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"DingtalkNotice\\\\\\\\\\\\\\":true}]\\\\\\"\\",\\n \\"Remark\\": \\"test\\",\\n \\"AddressPools\\": {\\n \\"AddressPool\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\",\\n \\"WeightValue\\": 1,\\n \\"SerialNumber\\": 1,\\n \\"RequestSource\\": {\\n \\"RequestSource\\": [\\n \\"[\\\\\\"default\\\\\\"]\\"\\n ]\\n },\\n \\"AddressPoolName\\": \\"AddressPool-1\\",\\n \\"AddressPoolType\\": \\"IPv4\\",\\n \\"AddressLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"Addresses\\": {\\n \\"Address\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressId\\": \\"addr-89564712295703****\\",\\n \\"WeightValue\\": 1,\\n \\"SerialNumber\\": 1,\\n \\"RequestSource\\": {\\n \\"RequestSource\\": [\\n \\"[\\\\\\"default\\\\\\"]\\"\\n ]\\n },\\n \\"Name\\": \\"Address-1\\",\\n \\"Type\\": \\"IPv4\\",\\n \\"Address\\": \\"223.5.XX.XX\\",\\n \\"AttributeInfo\\": \\"当前版本不支持返回此参数。\\",\\n \\"Remark\\": \\"test\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"AvailableMode\\": \\"auto\\",\\n \\"ManualAvailableStatus\\": \\"available\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"SeqNonPreemptiveSchedule\\": false\\n }\\n ]\\n },\\n \\"SeqNonPreemptiveSchedule\\": false\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取实例配置完整信息',
'summary' => '获取全局流量管理实例配置的完整信息,包括接入域名、告警通知、地址池、地址详细信息等。',
],
'ListCloudGtmInstanceConfigs' => [
'summary' => '获取实例配置列表,包括接入域名、地址池信息等。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsBCOB1Q',
],
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****'."\n",
],
],
[
'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',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => '调度实例id',
'description' => '全局流量管理3.0实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3h****',
],
],
[
'name' => 'ScheduleZoneName',
'in' => 'query',
'schema' => [
'title' => 'zone名称',
'description' => 'GTM接入域名的主域(example.com)或子域(a.example.com)。一般为GTM实例所在账号下,在云解析DNS控制台权威解析中托管的域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'title' => '启用状态',
'description' => '域名实例的启用状态:'."\n"
."\n"
.'- enable:启用状态,GTM实例智能调度策略生效。'."\n"
."\n"
.'- disable:禁用状态,GTM实例智能调度策略不可用。',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ScheduleDomainName',
'in' => 'query',
'schema' => [
'description' => 'GTM接入域名。格式为接入域名主机记录(ScheduleHostname参数值)+主域或子域(ScheduleZoneName参数值)。',
'type' => 'string',
'required' => false,
'example' => 'www.example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '域名实例配置的总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'InstanceConfigs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceConfig' => [
'description' => '实例配置列表。',
'type' => 'array',
'items' => [
'description' => '实例配置信息。',
'type' => 'object',
'properties' => [
'InstanceId' => [
'title' => '实例id',
'description' => '全局流量管理3.0实例ID。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3h****',
],
'ConfigId' => [
'title' => '实例id',
'description' => '域名实例配置ID。相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。',
'type' => 'string',
'example' => 'Config-000****'."\n",
],
'CreateTime' => [
'title' => '创建时间',
'description' => '实例配置创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '实例创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '实例配置最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z'."\n",
],
'UpdateTimestamp' => [
'description' => '实例配置最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'VersionCode' => [
'title' => '版本code',
'description' => '全局流量管理3.0实例版本:'."\n"
."\n"
.'- standard:标准版。'."\n"
."\n"
.'- ultimate:旗舰版。',
'type' => 'string',
'example' => 'ultimate',
],
'CommodityCode' => [
'title' => '商品code',
'description' => '商品编码:'."\n"
."\n"
.'- dns_gtm_public_cn:中国站商品编码。'."\n"
."\n"
.'- dns_gtm_public_intl:国际站商品编码。',
'type' => 'string',
'example' => 'dns_gtm_public_cn',
],
'ScheduleZoneMode' => [
'title' => '接入zone分配模式',
'description' => '接入域名分配模式:'."\n"
."\n"
.'- custom:自定义接入域名,用户自定义主机记录,并关联GTM实例所在账号下的主域或子域,生成接入域名。'."\n"
."\n"
.'- sys_assign:系统默认分配接入域名,本功能已经不支持,请勿选择此模式。',
'type' => 'string',
'example' => 'custom',
],
'ScheduleZoneName' => [
'title' => 'zone名称',
'description' => 'GTM接入域名的主域(example.com)或子域(a.example.com)。一般为GTM实例所在账号下,在云解析DNS控制台权威解析中托管的域名。',
'type' => 'string',
'example' => 'example.com',
],
'ScheduleHostname' => [
'title' => '主机记录',
'description' => 'GTM接入域名的主机记录。',
'type' => 'string',
'example' => 'www',
],
'ScheduleDomainName' => [
'title' => '域名,主机记录+zoneNamne',
'description' => 'GTM接入域名。格式为接入域名主机记录(ScheduleHostname参数值)+主域或子域(ScheduleZoneName参数值)。',
'type' => 'string',
'example' => 'www.example.com'."\n",
],
'ScheduleRrType' => [
'title' => '调度解析记录类型',
'description' => '调度域名的解析记录类型:'."\n"
."\n"
.'- A:IPv4地址'."\n"
."\n"
.'- AAAA:IPv6地址'."\n"
."\n"
.'- CNAME:域名',
'type' => 'string',
'example' => 'A',
],
'Ttl' => [
'title' => '调度调度实例的TTL',
'description' => '全局TTL(单位:秒),接入域名解析到地址池中地址的TTL值,影响解析记录在运营商LocalDNS中的缓存时间,支持自定义TTL值。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'AddressPoolLbStrategy' => [
'title' => '地址池的负载均衡策略',
'description' => '地址池之间的负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址池。并且每次对于所有地址池进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。若顺序号较小的地址池不可用时,返回下一个序号较小的地址池。'."\n"
."\n"
.'- weight:权重,支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址池,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'title' => '顺序负载策略模式(抢占式、非抢占式)',
'description' => '地址池间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址池。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址池。',
'type' => 'string',
'example' => 'preemptive',
],
'AvailableStatus' => [
'description' => '域名实例服务可用状态:'."\n"
."\n"
.'- available:可用,域名**启用**且健康状态为**正常**,接入域名的服务可用状态为**可用**。'."\n"
."\n"
.'- unavailable:不可用,域名**禁用**或健康状态为**异常**,接入域名的服务可用状态为**不可用**。',
'type' => 'string',
'example' => 'available',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '域名实例的启用状态:'."\n"
."\n"
.'- enable:启用状态,GTM实例智能调度策略生效。'."\n"
."\n"
.'- disable:禁用状态,GTM实例智能调度策略不可用。',
'type' => 'string',
'example' => 'enable',
],
'HealthStatus' => [
'title' => '监控状态',
'description' => '域名实例健康状态:'."\n"
."\n"
.'- ok:正常,接入域名引用的所有地址池全部可用。'."\n"
."\n"
.'- ok_alert:警告,接入域名引用的所有地址池部分不可用。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,接入域名引用的所有地址池全部不可用。此时,使用实例所引用的顺序号较小的非空地址池中的地址进行兜底解析,尽可能帮助客户端获得解析结果。',
'type' => 'string',
'example' => 'ok',
],
'Remark' => [
'title' => '备注',
'description' => '域名实例配置的备注。',
'type' => 'string',
'example' => 'test',
],
'AddressPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddressPool' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'description' => '地址池配置信息。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'description' => '地址池创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '地址池创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'description' => '地址池最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '地址池最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'AddressPoolId' => [
'title' => '地址池Id',
'description' => '地址池Id,地址池的唯一标识码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
'WeightValue' => [
'title' => '权重值',
'description' => '权重值(1-100之间的整数,包括1和100),支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SerialNumber' => [
'title' => '序号',
'description' => '顺序号,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestSource' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestSource' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'description' => '请求来源,是指解析请求的来源,GTM是根据终端所用LocalDNS的出口IP进行调度。若LocalDNS支持ECS (edns-client-subnet),也可以根据访问终端的IP进行智能调度。',
'type' => 'string',
'example' => '["default"]',
],
],
],
],
'AddressPoolName' => [
'title' => '地址池名称',
'description' => '地址池名称。',
'type' => 'string',
'example' => 'AddressPool-1'."\n",
],
'AddressPoolType' => [
'title' => '地址池类型ipv4、ipv6、domain',
'description' => '地址池类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'example' => 'IPv4',
],
'AddressLbStrategy' => [
'title' => '地址负载策略',
'description' => '地址池中地址间负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址。并且每次对于所有地址进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址(顺序号标识地址返回的优先级,越小优先级越高)。若顺序号较小的地址不可用时,返回下一个序号较小的地址。'."\n"
."\n"
.'- weight:权重,支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'title' => '顺序负载策略模式(抢占式、非抢占式)',
'description' => '地址间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址。',
'type' => 'string',
'example' => 'preemptive',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '地址池启用状态:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'HealthJudgement' => [
'title' => '健康判定',
'description' => '地址池健康状态:'."\n"
."\n"
.'- ok:正常,地址池引用的所有地址全部可用。'."\n"
."\n"
.'- ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。',
'type' => 'string',
'example' => 'ok',
],
'HealthStatus' => [
'title' => '健康状态',
'description' => '地址池健康状态:'."\n"
."\n"
.'- ok:正常,地址池引用的所有地址全部可用。'."\n"
."\n"
.'- ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。',
'type' => 'string',
'example' => 'ok',
],
'AvailableStatus' => [
'title' => '可用性状态',
'description' => '地址池可用性状态:'."\n"
."\n"
.'- available:可用'."\n"
."\n"
.'- unavailable:不可用',
'type' => 'string',
'example' => 'available',
],
'SeqNonPreemptiveSchedule' => [
'description' => '是否是顺序(非抢占)模式调度对象,针对于融合云纳管场景:'."\n"
."\n"
.'- true:是'."\n"
."\n"
.'- false:不是',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
'ConfigLoggingSwitchStatus' => [
'title' => '日志开关状态',
'description' => '日志开关状态',
'type' => 'string',
'example' => 'ENABLE',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 10,\\n \\"InstanceConfigs\\": {\\n \\"InstanceConfig\\": [\\n {\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3h****\\",\\n \\"ConfigId\\": \\"Config-000****\\\\n\\",\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\\\n\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"VersionCode\\": \\"ultimate\\",\\n \\"CommodityCode\\": \\"dns_gtm_public_cn\\",\\n \\"ScheduleZoneMode\\": \\"custom\\",\\n \\"ScheduleZoneName\\": \\"example.com\\",\\n \\"ScheduleHostname\\": \\"www\\",\\n \\"ScheduleDomainName\\": \\"www.example.com\\\\n\\",\\n \\"ScheduleRrType\\": \\"A\\",\\n \\"Ttl\\": 60,\\n \\"AddressPoolLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"Remark\\": \\"test\\",\\n \\"AddressPools\\": {\\n \\"AddressPool\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\",\\n \\"WeightValue\\": 1,\\n \\"SerialNumber\\": 1,\\n \\"RequestSource\\": {\\n \\"RequestSource\\": [\\n \\"[\\\\\\"default\\\\\\"]\\"\\n ]\\n },\\n \\"AddressPoolName\\": \\"AddressPool-1\\\\n\\",\\n \\"AddressPoolType\\": \\"IPv4\\",\\n \\"AddressLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthJudgement\\": \\"ok\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"SeqNonPreemptiveSchedule\\": false\\n }\\n ]\\n },\\n \\"ConfigLoggingSwitchStatus\\": \\"ENABLE\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取实例配置列表',
],
'DeleteCloudGtmInstanceConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '删除指定GTM 3.0实例配置的接入域名,仅支持删除单个。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-jmp3qnw****',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。'."\n"
.'调用[ListCloudGtmInstanceConfigs](~~2797349~~) 接口可查询域名实例对应的 ConfigId 值。',
'type' => 'string',
'required' => false,
'example' => 'config-00****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'Success' => [
'description' => '删除域名实例配置操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除接入域名',
'summary' => '根据传入参数删除GTM 3.0实例配置的接入域名。',
],
'UpdateCloudGtmInstanceConfigBasic' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值: '."\n"
.' '."\n"
.'- **zh-CN**:中文。'."\n"
."\n"
.'- **en-US**(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => '调度实例id',
'description' => '需要修改的GTM 3.0实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3h****',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'title' => '调度实例名称',
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。标识本次修改的配置对象。'."\n"
."\n"
.'调用[ListCloudGtmInstanceConfigs](~~ListCloudGtmInstanceConfigs~~)接口可查询域名实例对应的ConfigId值。',
'type' => 'string',
'required' => false,
'example' => 'Config-000****',
],
],
[
'name' => 'ScheduleZoneName',
'in' => 'query',
'schema' => [
'title' => 'zone名称',
'description' => 'GTM接入域名的主域(example.com)或子域(a.example.com)。一般为GTM实例所在账号下,在云解析DNS控制台权威解析中托管的域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'ScheduleHostname',
'in' => 'query',
'schema' => [
'title' => '主机记录',
'description' => 'GTM接入域名的主机记录。',
'type' => 'string',
'required' => false,
'example' => 'www',
],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => [
'title' => '调度调度实例的TTL',
'description' => '全局TTL(单位:秒),接入域名解析到地址池中地址的TTL值,影响解析记录在运营商LocalDNS中的缓存时间。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新实例全局TTL配置',
'summary' => '根据传入参数更新GTM3.0 实例全局TTL配置。',
],
'UpdateCloudGtmInstanceConfigLbStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值: '."\n"
.' '."\n"
.'- **zh-CN**:中文。'."\n"
."\n"
.'- **en-US**(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '需要修改的GTM 3.0实例 ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3h***',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识本次需要修改的域名实例配置。'."\n"
."\n"
.'调用 [ListCloudGtmInstanceConfigs](~~2797349~~) 接口可查询域名实例对应的 ConfigId 值。',
'type' => 'string',
'required' => false,
'example' => 'Config-000****',
],
],
[
'name' => 'AddressPoolLbStrategy',
'in' => 'query',
'schema' => [
'description' => '修改后的地址池之间的负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址池。并且每次对于所有地址池进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。若顺序号较小的地址池不可用时,返回下一个序号较小的地址池。'."\n"
."\n"
.'- weight:权重,支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址池,实现用户就近访问的效果。',
'type' => 'string',
'required' => false,
'example' => 'sequence',
],
],
[
'name' => 'SequenceLbStrategyMode',
'in' => 'query',
'schema' => [
'description' => '地址池间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址池。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址池。',
'type' => 'string',
'required' => false,
'example' => 'preemptive',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '0F32959D-417B-4D66-8463-68606605E3E2',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F32959D-417B-4D66-8463-68606605E3E2\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新实例负载均衡策略',
'summary' => '根据传入参数更新实例负载均衡策略。',
],
'UpdateCloudGtmInstanceConfigEnableStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值: '."\n"
.' '."\n"
.'- **zh-CN**:中文。'."\n"
."\n"
.'- **en-US**(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => '调度实例id',
'description' => '需要修改的GTM 3.0实例 ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3h****',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'title' => '调度实例id',
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。'."\n"
."\n"
.'调用[ListCloudGtmInstanceConfigs]( ~~2797349~~)接口可查询域名实例对应的 ConfigId 值。',
'type' => 'string',
'required' => false,
'example' => 'Config-000****',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'title' => '启用状态',
'description' => '域名实例的启用状态:'."\n"
."\n"
.'- enable:启用。'."\n"
."\n"
.'- disable:禁用。',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新实例配置启用状态',
'summary' => '根据传入参数更新实例启动状态。',
'description' => '- 域名**启用**且健康状态为**正常**,接入域名的服务可用状态为**可用**。'."\n"
."\n"
.'- 域名**禁用**或健康状态为**异常**,接入域名的服务可用状态为**不可用**。',
],
'UpdateCloudGtmInstanceConfigRemark' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值: '."\n"
.' '."\n"
.'- **zh-CN**:中文。'."\n"
."\n"
.'- **en-US**(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '需要修改备注信息的全局流量管理GTM3.0实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3h****',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识本次需要修改的域名实例配置。'."\n"
."\n"
.'调用[ListCloudGtmInstanceConfigs](~~2797349~~) 接口可查询域名实例对应的 ConfigId 值。',
'type' => 'string',
'required' => false,
'example' => 'Config-000****',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注,传入参数即为更新后的目标备注内容。',
'type' => 'string',
'required' => false,
'example' => 'API',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新实例备注信息',
'summary' => '根据传入的参数更新实例备注信息。',
],
'ListCloudGtmInstances' => [
'summary' => '根据传入参数获取GTM 3.0实例列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsBCOB1Q',
],
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US:英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'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',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => '调度实例id',
'description' => 'GTM实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-jmp3qnw****',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'title' => '调度实例名称',
'description' => '实例名称,方便区分实例的业务用途。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ChargeType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'title' => '指定实例的付费类型',
'description' => '指定实例的付费类型',
'type' => 'string',
'required' => false,
'example' => 'postpay/prepay',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '实例总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Instance' => [
'description' => '实例列表。',
'type' => 'array',
'items' => [
'description' => '实例信息。',
'type' => 'object',
'properties' => [
'InstanceId' => [
'title' => '实例id',
'description' => 'GTM实例ID。',
'type' => 'string',
'example' => 'gtm-cn-jmp3qnw****',
],
'InstanceName' => [
'title' => '调度实例名称',
'description' => '实例名称。',
'type' => 'string',
'example' => 'test',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '实例创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1231298343343',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '实例最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z'."\n",
],
'UpdateTimestamp' => [
'description' => '实例最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1231298343343',
],
'VersionCode' => [
'title' => '版本code',
'description' => 'GTM实例版本:'."\n"
."\n"
.'- standard:标准版'."\n"
."\n"
.'- ultimate:旗舰版',
'type' => 'string',
'example' => 'ultimate',
],
'CommodityCode' => [
'title' => '商品code',
'description' => '商品编码:'."\n"
."\n"
.'- dns_gtm_public_cn:中国站商品编码。'."\n"
."\n"
.'- dns_gtm_public_intl:国际站商品编码。',
'type' => 'string',
'example' => 'dns_gtm_public_cn',
],
'MonthlySmsQuota' => [
'title' => '短消息配额',
'description' => '短息配额,仅中国站支持短消息,国际站不支持短消息。',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'MonitorTaskQuota' => [
'title' => '监控任务配额',
'description' => '监控探测任务配额。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'ExpireTimestamp' => [
'description' => '实例到期时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1231298343343',
],
'ExpireTime' => [
'title' => '到期日',
'description' => '实例到期时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'ScheduleDomainName' => [
'description' => 'GTM接入域名。格式为接入域名主机记录(ScheduleHostname参数值)+主域或子域(ScheduleZoneName参数值)。',
'type' => 'string',
'example' => 'www.example.com',
],
'MonthlySmsUsed' => [
'description' => '当月短信发送量,仅中国站支持短信,国际站不支持短信。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'MonthlyEmailUsed' => [
'description' => '当月邮件发送量。',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'MonthlyWebhookUsed' => [
'description' => '当月 webhook 发送量。',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
'ChargeType' => [
'title' => '实例的付费类型',
'description' => '实例的付费类型',
'type' => 'string',
'example' => 'postpay / prepay',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 15,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"InstanceId\\": \\"gtm-cn-jmp3qnw****\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1231298343343,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\\\n\\",\\n \\"UpdateTimestamp\\": 1231298343343,\\n \\"VersionCode\\": \\"ultimate\\",\\n \\"CommodityCode\\": \\"dns_gtm_public_cn\\",\\n \\"MonthlySmsQuota\\": 1000,\\n \\"MonitorTaskQuota\\": 100,\\n \\"ExpireTimestamp\\": 1231298343343,\\n \\"ExpireTime\\": \\"2024-03-15T01:46Z\\",\\n \\"ScheduleDomainName\\": \\"www.example.com\\",\\n \\"MonthlySmsUsed\\": 100,\\n \\"MonthlyEmailUsed\\": 50,\\n \\"MonthlyWebhookUsed\\": 80,\\n \\"ChargeType\\": \\"postpay / prepay\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取实例列表',
],
'SearchCloudGtmInstances' => [
'summary' => '根据传入参数搜索实例列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsBCOB1Q',
],
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值的语言,取值:'."\n"
."\n"
.'- **zh-CN**:中文。'."\n"
.'- **en-US**:英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性。',
'type' => 'string',
'required' => false,
'example' => ' '."\n"
.'1ae05db4-10e7-11ef-b126-00163e24****'."\n",
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'title' => '',
'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',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => '调度实例id',
'description' => '全局流量管理3.0实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3h****',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'title' => '调度实例名称',
'description' => '调度实例名称,支持模糊搜索。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ChargeType',
'in' => 'query',
'schema' => [
'title' => '付费类型',
'description' => '付费类型',
'type' => 'string',
'required' => false,
'example' => 'prepay / postpay',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '搜索出来的实例总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Instance' => [
'description' => '实例列表。',
'type' => 'array',
'items' => [
'description' => '实例信息。',
'type' => 'object',
'properties' => [
'InstanceId' => [
'title' => '实例id',
'description' => '全局流量管理3.0实例ID。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3h****',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '实例创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1710467214858',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '实例最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '实例最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1710467214858',
],
'VersionCode' => [
'title' => '版本code',
'description' => '全局流量管理3.0实例版本:'."\n"
."\n"
.'- standard:标准版'."\n"
."\n"
.'- ultimate:旗舰版',
'type' => 'string',
'example' => 'ultimate',
],
'CommodityCode' => [
'title' => '商品code',
'description' => '商品编码:'."\n"
."\n"
.'- dns_gtm_public_cn:中国站商品编码。'."\n"
."\n"
.'- dns_gtm_public_intl:国际站商品编码。',
'type' => 'string',
'example' => 'dns_gtm_public_cn',
],
'MonthlySmsQuota' => [
'title' => '短消息配额',
'description' => '短息配额,仅中国站支持短消息,国际站不支持短消息。',
'type' => 'integer',
'format' => 'int32',
'example' => '2000',
],
'MonitorTaskQuota' => [
'title' => '监控任务配额',
'description' => '监控探测任务配额。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'InstanceName' => [
'title' => '调度实例名称',
'description' => '调度实例名称。',
'type' => 'string',
'example' => 'test',
],
'ExpireTime' => [
'description' => '实例到期时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '2024-09-05T16:00Z',
],
'ExpireTimestamp' => [
'title' => '到期日',
'description' => '实例到期时间(时间戳)。',
'type' => 'string',
'example' => '1725552000000',
],
'ScheduleDomainName' => [
'description' => 'GTM接入域名。格式为接入域名主机记录(ScheduleHostname参数值)+主域或子域(ScheduleZoneName参数值)',
'type' => 'string',
'example' => 'www.example.com',
],
'MonthlySmsUsed' => [
'description' => '当月短信发送量,仅中国站支持短信,国际站不支持短信。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'MonthlyEmailUsed' => [
'description' => '当月邮件发送量。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'MonthlyWebhookUsed' => [
'description' => '当月 webhook 发送量。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'ChargeType' => [
'title' => '实例的付费类型',
'description' => '实例的付费类型',
'type' => 'string',
'example' => 'postpay / prepay',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 10,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3h****\\",\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1710467214858,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1710467214858,\\n \\"VersionCode\\": \\"ultimate\\",\\n \\"CommodityCode\\": \\"dns_gtm_public_cn\\",\\n \\"MonthlySmsQuota\\": 2000,\\n \\"MonitorTaskQuota\\": 100,\\n \\"InstanceName\\": \\"test\\",\\n \\"ExpireTime\\": 0,\\n \\"ExpireTimestamp\\": \\"1725552000000\\",\\n \\"ScheduleDomainName\\": \\"www.example.com\\",\\n \\"MonthlySmsUsed\\": 200,\\n \\"MonthlyEmailUsed\\": 200,\\n \\"MonthlyWebhookUsed\\": 100,\\n \\"ChargeType\\": \\"postpay / prepay\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '搜索实例列表',
],
'SearchCloudGtmInstanceConfigs' => [
'summary' => '根据传入参数搜索实例配置列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsBCOB1Q',
],
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'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',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => '调度实例id',
'description' => '全局流量管理GTM 3.0实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3h****',
],
],
[
'name' => 'ScheduleZoneName',
'in' => 'query',
'schema' => [
'title' => 'zone名称',
'description' => 'GTM接入域名的主域(example.com)或子域(a.example.com)。一般为GTM实例所在账号下,在云解析DNS控制台权威解析中托管的域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'ScheduleDomainName',
'in' => 'query',
'schema' => [
'title' => 'zone名称',
'description' => 'GTM接入域名。格式为接入域名主机记录(ScheduleHostname参数值)+主域或子域(ScheduleZoneName参数值)',
'type' => 'string',
'required' => false,
'example' => 'www.example.com',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'title' => '启用状态',
'description' => '域名实例的启用状态:'."\n"
."\n"
.'- enable:启用状态,GTM实例智能调度策略生效。'."\n"
."\n"
.'- disable:禁用状态,GTM实例智能调度策略不可用。',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '域名实例的备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'HealthStatus',
'in' => 'query',
'schema' => [
'description' => '域名实例健康状态:'."\n"
."\n"
.'- ok:正常,接入域名引用的所有地址池全部可用。'."\n"
."\n"
.'- ok_alert:警告,接入域名引用的所有地址池部分不可用。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,接入域名引用的所有地址池全部不可用。此时,使用实例所引用的顺序号较小的非空地址池中的地址进行兜底解析,尽可能帮助客户端获得解析结果。',
'type' => 'string',
'required' => false,
'example' => 'ok',
],
],
[
'name' => 'AvailableStatus',
'in' => 'query',
'schema' => [
'description' => '域名实例服务可用状态:'."\n"
."\n"
.'- available:可用,域名**启用**且健康状态为**正常**,接入域名的服务可用状态为**可用**。'."\n"
."\n"
.'- unavailable:不可用,域名**禁用**或健康状态为**异常**,接入域名的服务可用状态为**不可用**。',
'type' => 'string',
'required' => false,
'example' => 'available',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '实例配置列表总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'InstanceConfigs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceConfig' => [
'description' => '实例列表。',
'type' => 'array',
'items' => [
'description' => '实例信息。',
'type' => 'object',
'properties' => [
'InstanceId' => [
'title' => '实例id',
'description' => '全局流量管理GTM 3.0实例ID。',
'type' => 'string',
'example' => 'gtm-cn-x0r38e0****',
],
'ConfigId' => [
'title' => '实例id',
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。',
'type' => 'string',
'example' => 'Config-000****'."\n",
],
'CreateTime' => [
'title' => '创建时间',
'description' => '域名实例创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '域名实例创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '域名实例最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '域名实例最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357'."\n",
],
'VersionCode' => [
'title' => '版本code',
'description' => '全局流量管理3.0实例版本:'."\n"
."\n"
.'- standard:标准版'."\n"
."\n"
.'- ultimate:旗舰版',
'type' => 'string',
'example' => 'ultimate',
],
'CommodityCode' => [
'title' => '商品code',
'description' => '商品编码:'."\n"
."\n"
.'- dns_gtm_public_cn:中国站商品编码。'."\n"
."\n"
.'- dns_gtm_public_intl:国际站商品编码。',
'type' => 'string',
'example' => 'dns_gtm_public_cn',
],
'ScheduleZoneMode' => [
'title' => '接入zone分配模式',
'description' => '接入域名分配模式:'."\n"
."\n"
.'- custom:自定义接入域名,用户自定义主机记录,并关联GTM实例所在账号下在权威解析中托管的域名,生成接入域名。'."\n"
."\n"
.'- sys_assign:系统默认分配接入域名,本功能已经不支持,请勿选择此模式。',
'type' => 'string',
'example' => 'custom',
],
'ScheduleZoneName' => [
'title' => 'zone名称',
'description' => 'GTM接入域名的主域(example.com)或子域(a.example.com)。一般为GTM实例所在账号下,在云解析DNS控制台权威解析中托管的域名。',
'type' => 'string',
'example' => 'example.com',
],
'ScheduleHostname' => [
'title' => '主机记录',
'description' => 'GTM接入域名的主机记录。',
'type' => 'string',
'example' => 'www',
],
'ScheduleDomainName' => [
'title' => '域名,主机记录+zoneNamne',
'description' => 'GTM接入域名。格式为接入域名主机记录(ScheduleHostname参数值)+主域或子域(ScheduleZoneName参数值)',
'type' => 'string',
'example' => 'www.example.com',
],
'ScheduleRrType' => [
'title' => '调度解析记录类型',
'description' => '调度域名的解析记录类型:'."\n"
."\n"
.'- A:IPv4地址'."\n"
."\n"
.'- AAAA:IPv6地址'."\n"
."\n"
.'- CNAME:域名',
'type' => 'string',
'example' => 'A',
],
'Ttl' => [
'title' => '调度调度实例的TTL',
'description' => '全局TTL(单位:秒),接入域名解析到地址池中地址的TTL值,影响解析记录在运营商LocalDNS中的缓存时间,支持自定义TTL值。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'AddressPoolLbStrategy' => [
'title' => '地址池的负载均衡策略',
'description' => '地址池之间的负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址池。并且每次对于所有地址池进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。若顺序号较小的地址池不可用时,返回下一个序号较小的地址池。'."\n"
."\n"
.'- weight:权重,支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址池,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'title' => '顺序负载策略模式(抢占式、非抢占式)',
'description' => '地址池间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址池。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址池。',
'type' => 'string',
'example' => 'preemptive',
],
'AvailableStatus' => [
'description' => '域名实例服务可用状态:'."\n"
."\n"
.'- available:可用,域名**启用**且健康状态为**正常**,接入域名的服务可用状态为**可用**。'."\n"
."\n"
.'- unavailable:不可用,域名**禁用**或健康状态为**异常**,接入域名的服务可用状态为**不可用**。',
'type' => 'string',
'example' => 'available',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '域名实例的启用状态:'."\n"
."\n"
.'- enable:启用状态,GTM实例智能调度策略生效。'."\n"
."\n"
.'- disable:禁用状态,GTM实例智能调度策略不可用。',
'type' => 'string',
'example' => 'enable',
],
'HealthStatus' => [
'title' => '监控状态',
'description' => '域名实例健康状态:'."\n"
."\n"
.'- ok:正常,接入域名引用的所有地址池全部可用。'."\n"
."\n"
.'- ok_alert:警告,接入域名引用的所有地址池部分不可用。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,接入域名引用的所有地址池全部不可用。此时,使用实例所引用的顺序号较小的非空地址池中的地址进行兜底解析,尽可能帮助客户端获得解析结果。',
'type' => 'string',
'example' => 'ok',
],
'Remark' => [
'title' => '备注',
'description' => '域名实例的备注。',
'type' => 'string',
'example' => 'test',
],
'AddressPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddressPool' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'description' => '地址池信息。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'description' => '地址池创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '地址池创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'description' => '地址池最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'AddressPoolId' => [
'title' => '地址池Id',
'description' => '地址池ID,唯一标识地址池。',
'type' => 'string',
'example' => 'pool-89564504435014**60',
],
'WeightValue' => [
'title' => '权重值',
'description' => '权重值(1-100之间的整数,包括1和100),支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SerialNumber' => [
'title' => '序号',
'description' => '顺序号,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestSource' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestSource' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'description' => '请求来源,是指解析请求的来源,GTM是根据终端所用LocalDNS的出口IP进行调度。若LocalDNS支持ECS (edns-client-subnet),也可以根据访问终端的IP进行智能调度。',
'type' => 'string',
'example' => '["default"]',
],
],
],
],
'AddressPoolName' => [
'title' => '地址池名称',
'description' => '地址池名称。',
'type' => 'string',
'example' => 'AddressPool-1',
],
'AddressPoolType' => [
'title' => '地址池类型ipv4、ipv6、domain',
'description' => '地址池类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'example' => 'IPv4',
],
'AddressLbStrategy' => [
'title' => '地址负载策略',
'description' => '地址池中地址间负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址。并且每次对于所有地址进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址(顺序号标识地址返回的优先级,越小优先级越高)。若顺序号较小的地址不可用时,返回下一个序号较小的地址。'."\n"
."\n"
.'- weight:权重,支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'title' => '顺序负载策略模式(抢占式、非抢占式)',
'description' => '地址间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址。',
'type' => 'string',
'example' => 'preemptive',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '地址池启用状态:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'HealthJudgement' => [
'title' => '健康判定',
'description' => '地址池健康状态判定条件:'."\n"
."\n"
.'- any_ok:地址池内至少1个地址是可用地址。'."\n"
."\n"
.'- p30_ok:地址池内至少30%地址是可用地址。'."\n"
."\n"
.'- p50_ok:地址池内至少50%地址是可用地址。'."\n"
."\n"
.'- p70_ok:地址池内至少70%地址是可用地址。'."\n"
."\n"
.'- all_ok:地址池内地址全部可用。',
'type' => 'string',
'example' => 'any_ok',
],
'HealthStatus' => [
'title' => '健康状态',
'description' => '地址池健康状态:'."\n"
."\n"
.'- ok:正常,地址池引用的所有地址全部可用。'."\n"
."\n"
.'- ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。',
'type' => 'string',
'example' => 'ok',
],
'AvailableStatus' => [
'title' => '可用性状态',
'description' => '地址池可用性状态:'."\n"
."\n"
.'- available:可用'."\n"
."\n"
.'- unavailable:不可用',
'type' => 'string',
'example' => ' available',
],
'SeqNonPreemptiveSchedule' => [
'description' => '是否是顺序(非抢占)模式调度对象,针对于融合云纳管场景:'."\n"
."\n"
.'- true:是'."\n"
."\n"
.'- false:不是',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
'ConfigLoggingSwitchStatus' => [
'title' => '日志开关状态',
'description' => '日志开关状态',
'type' => 'string',
'example' => 'ENABLE',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 15,\\n \\"InstanceConfigs\\": {\\n \\"InstanceConfig\\": [\\n {\\n \\"InstanceId\\": \\"gtm-cn-x0r38e0****\\",\\n \\"ConfigId\\": \\"Config-000****\\\\n\\",\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"VersionCode\\": \\"ultimate\\",\\n \\"CommodityCode\\": \\"dns_gtm_public_cn\\",\\n \\"ScheduleZoneMode\\": \\"custom\\",\\n \\"ScheduleZoneName\\": \\"example.com\\",\\n \\"ScheduleHostname\\": \\"www\\",\\n \\"ScheduleDomainName\\": \\"www.example.com\\",\\n \\"ScheduleRrType\\": \\"A\\",\\n \\"Ttl\\": 60,\\n \\"AddressPoolLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"Remark\\": \\"test\\",\\n \\"AddressPools\\": {\\n \\"AddressPool\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressPoolId\\": \\"pool-89564504435014**60\\",\\n \\"WeightValue\\": 1,\\n \\"SerialNumber\\": 1,\\n \\"RequestSource\\": {\\n \\"RequestSource\\": [\\n \\"[\\\\\\"default\\\\\\"]\\"\\n ]\\n },\\n \\"AddressPoolName\\": \\"AddressPool-1\\",\\n \\"AddressPoolType\\": \\"IPv4\\",\\n \\"AddressLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"AvailableStatus\\": \\" available\\",\\n \\"SeqNonPreemptiveSchedule\\": false\\n }\\n ]\\n },\\n \\"ConfigLoggingSwitchStatus\\": \\"ENABLE\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '搜索实例配置列表',
],
'DescribeCloudGtmSummary' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US:英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '199C3699-9A7B-41A1-BB5A-F1E862D3CB38',
],
'InstanceTotalCount' => [
'description' => '当前账户下实例总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'MonitorTaskTotalQuota' => [
'description' => '用户探测任务数配额。',
'type' => 'integer',
'format' => 'int32',
'example' => '101',
],
'MonitorTaskTotalCount' => [
'description' => '用户已配置的探测任务总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"199C3699-9A7B-41A1-BB5A-F1E862D3CB38\\",\\n \\"InstanceTotalCount\\": 10,\\n \\"MonitorTaskTotalQuota\\": 101,\\n \\"MonitorTaskTotalCount\\": 20\\n}","type":"json"}]',
'title' => '获取实例概要信息',
],
'CreateCloudGtmAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认):英文。',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'required' => true,
'example' => 'Address-1',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '地址类型(IPv4, IPv6, DOMAIN)',
'description' => '地址类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'required' => true,
'example' => 'IPv4',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'title' => '地址',
'description' => 'IP地址或者域名。',
'type' => 'string',
'required' => true,
'example' => '223.5.XX.XX',
],
],
[
'name' => 'AttributeInfo',
'in' => 'query',
'schema' => [
'title' => '地址归属信息',
'description' => '地址归属信息。',
'type' => 'string',
'required' => false,
'example' => '当前版本不支持传入此参数,请不要传入参数。',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '表示该地址当前启用状态:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'required' => true,
'example' => 'enable',
],
],
[
'name' => 'AvailableMode',
'in' => 'query',
'schema' => [
'title' => '可用状态设置模式',
'description' => '地址探测异常切换方式:'."\n"
."\n"
.'- auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。'."\n"
."\n"
.'- manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。',
'type' => 'string',
'required' => true,
'example' => 'auto',
],
],
[
'name' => 'ManualAvailableStatus',
'in' => 'query',
'schema' => [
'title' => '手动设置的可用状态',
'description' => '当地址探测异常切换模式为**manual**时,地址设置的可用状态:'."\n"
."\n"
.'- available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'- unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'required' => false,
'example' => 'available',
],
],
[
'name' => 'HealthJudgement',
'in' => 'query',
'schema' => [
'title' => '地址健康状态判定为ok 的方式:',
'description' => '地址健康状态判定条件(HealthTasks 不为空时必填):'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'required' => true,
'example' => 'p50_ok',
],
],
[
'name' => 'HealthTasks',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '健康检查配置',
'description' => '地址关联的健康探测任务列表。',
'type' => 'array',
'items' => [
'description' => '地址关联的健康探测模板。',
'type' => 'object',
'properties' => [
'Port' => [
'title' => '服务端口',
'description' => '健康检查探测的目标地址服务端口,当健康检查选择Ping协议时,不支持服务端口的配置。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '80',
],
'TemplateId' => [
'title' => '探测模板',
'description' => '地址关联的健康探测模板ID。',
'type' => 'string',
'required' => false,
'example' => 'mtp-89518052425100****',
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '46973D4C-E3E4-4ABA-9190-9A9DE406C7E',
],
'Success' => [
'description' => '创建地址操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
'AddressId' => [
'description' => '生成的地址ID,地址唯一标识码。',
'type' => 'string',
'example' => 'addr-8951821811436****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\",\\n \\"Success\\": true,\\n \\"AddressId\\": \\"addr-8951821811436****\\"\\n}","type":"json"}]',
'title' => '创建地址',
'summary' => '根据传入参数创建地址。',
],
'UpdateCloudGtmAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressId',
'in' => 'query',
'schema' => [
'title' => '地址 ID',
'description' => '地址的ID,地址唯一标识码。',
'type' => 'string',
'required' => true,
'example' => 'addr-89518218114368****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '地址名称',
'description' => '修改后的地址名称。',
'type' => 'string',
'required' => false,
'example' => 'Address-1',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'title' => '地址',
'description' => '修改后的IP地址或者域名。',
'type' => 'string',
'required' => false,
'example' => '223.5.XX.XX',
],
],
[
'name' => 'AttributeInfo',
'in' => 'query',
'schema' => [
'title' => '地址归属信息',
'description' => '地址归属信息。',
'type' => 'string',
'required' => false,
'example' => '当前版本不支持此参数,不需要传入此参数。',
],
],
[
'name' => 'HealthJudgement',
'in' => 'query',
'schema' => [
'title' => '地址健康状态判定为ok 的方式:',
'description' => '修改后的地址健康状态判定条件:'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'required' => false,
'example' => 'p50_ok',
],
],
[
'name' => 'HealthTasks',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'json',
'schema' => [
'title' => '健康检查配置',
'description' => '健康探测任务列表。',
'type' => 'array',
'items' => [
'description' => '地址关联的健康探测任务列表。',
'type' => 'object',
'properties' => [
'Port' => [
'title' => '服务端口',
'description' => '健康检查探测的目标地址服务端口,当健康检查选择Ping协议时,不支持服务端口的配置。'."\n"
."\n"
.'- 传入参数为空:删除当前已配置的端口号;'."\n"
."\n"
.'- 传入参数不为空:根据传入参数更新端口号;',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '80',
],
'TemplateId' => [
'title' => '探测模板',
'description' => '地址关联的健康探测模板ID。如果配置了健康检查的端口号,此参数必填。'."\n"
."\n"
.'- 传入参数为空:删除当前已配置的探测模板;'."\n"
."\n"
.'- 传入参数不为空:根据传入参数更新探测模板;',
'type' => 'string',
'required' => false,
'example' => 'mtp-89518052425100****',
],
],
'required' => false,
],
'deprecated' => false,
'required' => false,
'minItems' => 0,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'Success' => [
'description' => '修改地址基础配置操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改地址基础配置',
'summary' => '调用 UpdateCloudGtmAddress 修改指定地址基础配置。',
],
'DescribeCloudGtmAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressId',
'in' => 'query',
'schema' => [
'description' => '地址ID,地址唯一标识码。',
'type' => 'string',
'required' => true,
'example' => 'addr-89518218114368****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'AddressId' => [
'title' => '地址 ID',
'description' => '地址ID,地址唯一标识码。',
'type' => 'string',
'example' => 'addr-89518218114368****'."\n",
],
'CreateTime' => [
'title' => '创建时间',
'description' => '地址创建时间。',
'type' => 'string',
'example' => '2024-03-23T13:09Z',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址配置的最后修改时间。',
'type' => 'string',
'example' => '2024-03-29T13:20Z',
],
'UpdateTimestamp' => [
'description' => '修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'Name' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'example' => 'test',
],
'Type' => [
'title' => '地址类型',
'description' => '地址类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'example' => 'IPv4',
],
'Address' => [
'title' => '地址',
'description' => 'IP地址或者域名。',
'type' => 'string',
'example' => '223.5.XX.XX',
],
'AttributeInfo' => [
'title' => '地址归属信息',
'description' => '地址归属信息。',
'type' => 'string',
'example' => '当前版本不支持此参数,不会返回地址归属信息。',
],
'Remark' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'example' => 'test1',
],
'EnableStatus' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '表示该地址当前启用状态:'."\n"
."\n"
.'enable:启用状态'."\n"
."\n"
.'disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'AvailableMode' => [
'title' => '可用状态设置模式',
'description' => '地址探测异常切换方式:'."\n"
."\n"
.'- auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。'."\n"
."\n"
.'- manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。',
'type' => 'string',
'example' => 'auto',
],
'ManualAvailableStatus' => [
'title' => '手动设置的可用状态',
'description' => '当地址探测异常切换模式为manual时,地址设置的可用状态:'."\n"
."\n"
.'- available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'- unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'example' => 'available',
],
'AvailableStatus' => [
'title' => '地址可用状态',
'description' => '地址可用状态:'."\n"
."\n"
.'- available:可用'."\n"
."\n"
.'- unavailable:不可用',
'type' => 'string',
'example' => 'available',
],
'HealthStatus' => [
'title' => '地址的健康状态:',
'description' => '地址健康检查探测结果:'."\n"
."\n"
.'- ok:地址引用的健康探测模板探测任务全部正常。'."\n"
."\n"
.' - ok_alert:地址引用的健康探测模板探测任务部分异常,地址判定为正常状态。'."\n"
."\n"
.' - ok_no_monitor:地址没有引用任何健康探测模板。'."\n"
."\n"
.' - exceptional:地址引用的健康探测模板探测任务部分或全部异常,但地址判定为异常状态。',
'type' => 'string',
'example' => 'ok',
],
'HealthJudgement' => [
'title' => '地址健康状态判定为ok 的方式:',
'description' => '地址健康状态判定条件:'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'example' => 'p50_ok',
],
'HealthTasks' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HealthTask' => [
'title' => '健康探测任务列表',
'description' => '健康探测任务列表。',
'type' => 'array',
'items' => [
'description' => '地址引用的健康探测任务列表。',
'type' => 'object',
'properties' => [
'Port' => [
'description' => '健康检查探测的目标地址服务端口,当健康检查选择Ping协议时,不支持服务端口的配置。',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
'TemplateId' => [
'description' => '地址关联的健康探测模板ID。',
'type' => 'string',
'example' => 'mtp-89518052425100****',
],
'TemplateName' => [
'description' => '健康探测模板名称。',
'type' => 'string',
'example' => 'Ping-IPv4',
],
'MonitorStatus' => [
'description' => '健康探测模板探测任务状态:'."\n"
.'- ok:正常。'."\n"
."\n"
.'- alert:告警。'."\n"
."\n"
.'- no_data:无数据,一般是健康探测任务刚创建,探测任务数据暂未采集到。',
'type' => 'string',
'example' => 'ok',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"AddressId\\": \\"addr-89518218114368****\\\\n\\",\\n \\"CreateTime\\": \\"2024-03-23T13:09Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-29T13:20Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"IPv4\\",\\n \\"Address\\": \\"223.5.XX.XX\\",\\n \\"AttributeInfo\\": \\"当前版本不支持此参数,不会返回地址归属信息。\\",\\n \\"Remark\\": \\"test1\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"AvailableMode\\": \\"auto\\",\\n \\"ManualAvailableStatus\\": \\"available\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"HealthJudgement\\": \\"p50_ok\\",\\n \\"HealthTasks\\": {\\n \\"HealthTask\\": [\\n {\\n \\"Port\\": 80,\\n \\"TemplateId\\": \\"mtp-89518052425100****\\",\\n \\"TemplateName\\": \\"Ping-IPv4\\",\\n \\"MonitorStatus\\": \\"ok\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取地址配置信息',
'summary' => '根据传入参数获取地址配置信息。',
],
'DeleteCloudGtmAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****'."\n",
],
],
[
'name' => 'AddressId',
'in' => 'query',
'schema' => [
'title' => '地址 ID',
'description' => '地址ID,地址的唯一识别码。',
'type' => 'string',
'required' => true,
'example' => 'addr-89518218114368****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'Success' => [
'description' => '删除地址操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除地址',
'summary' => '根据传入参数删除地址。',
],
'UpdateCloudGtmAddressRemark' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressId',
'in' => 'query',
'schema' => [
'title' => '地址 ID',
'description' => '地址的ID,地址唯一标识码。',
'type' => 'string',
'required' => true,
'example' => 'addr-89518218114368****',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'title' => '备注',
'description' => '传入的参数作为更新后的备注,传空值则删除备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'Success' => [
'description' => '本次修改操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改地址备注',
'summary' => '通过地址的 ID修改地址备注信息。',
],
'ListCloudGtmAddresses' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US:英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '地址类型',
'description' => '地址类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'required' => false,
'example' => 'IPv4',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'title' => '地址',
'description' => 'IP地址或者域名。',
'type' => 'string',
'required' => false,
'example' => '223.5.XX.XX',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '表示地址当前是否可用:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'HealthStatus',
'in' => 'query',
'schema' => [
'title' => '地址探测结果: ok, ok_alert, ok_no_monitor, exceptional',
'description' => '地址健康检查探测状态:'."\n"
."\n"
.'- ok:地址引用的健康探测模板探测任务全部正常。'."\n"
."\n"
.' - ok_alert:地址引用的健康探测模板探测任务部分异常,但地址判定为正常状态。'."\n"
."\n"
.' - ok_no_monitor:地址没有引用任何健康探测模板。'."\n"
."\n"
.' - exceptional:地址引用的健康探测模板探测任务部分或全部异常,且地址判定为异常状态。',
'type' => 'string',
'required' => false,
'example' => 'ok',
],
],
[
'name' => 'MonitorTemplateId',
'in' => 'query',
'schema' => [
'description' => '健康检查模板ID,健康探测模板的唯一标识码。',
'type' => 'string',
'required' => false,
'example' => 'mtp-89518052425100****',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
[
'name' => 'AddressId',
'in' => 'query',
'schema' => [
'description' => '地址ID,地址唯一标识码。',
'type' => 'string',
'required' => false,
'example' => 'addr-89518218114368****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalItems' => [
'description' => '获取到地址列表中的地址总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'Addresses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Address' => [
'description' => '地址列表。',
'type' => 'array',
'items' => [
'description' => '地址列表。',
'type' => 'object',
'properties' => [
'AddressId' => [
'title' => '地址 ID',
'description' => '地址ID,唯一标识该地址。',
'type' => 'string',
'example' => 'addr-89518218114368****',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '地址创建时间。',
'type' => 'string',
'example' => '2024-03-23T13:09Z',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址修改时间。',
'type' => 'string',
'example' => '2024-03-29T13:20Z',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690824357',
],
'Name' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'example' => 'Address-1',
],
'Type' => [
'title' => '地址类型',
'description' => '地址类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'example' => 'IPv4',
],
'Address' => [
'title' => '地址',
'description' => 'IP地址或者域名。',
'type' => 'string',
'example' => '223.5.XX.XX',
],
'AttributeInfo' => [
'title' => '地址归属信息',
'description' => '地址归属信息。',
'type' => 'string',
'example' => '当前版本不支持此参数,不会返回地址归属信息。',
],
'Remark' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'example' => 'app',
],
'EnableStatus' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '表示地址当前是否可用:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'AvailableMode' => [
'title' => '可用状态设置模式',
'description' => '地址探测异常切换方式:'."\n"
."\n"
.'auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。'."\n"
."\n"
.'manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。',
'type' => 'string',
'example' => 'auto',
],
'ManualAvailableStatus' => [
'title' => '手动设置的可用状态',
'description' => '当地址探测异常切换模式为manual时,地址设置的可用状态:'."\n"
."\n"
.'available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'example' => 'available',
],
'AvailableStatus' => [
'title' => '地址可用状态',
'description' => '地址可用状态:'."\n"
."\n"
.'- available:地址可用。'."\n"
."\n"
.'- unavailable:地址不可用。',
'type' => 'string',
'example' => 'available',
],
'HealthStatus' => [
'title' => '地址的健康状态:',
'description' => '地址健康检查探测状态:'."\n"
."\n"
.'- ok:地址引用的健康探测模板探测任务全部正常。'."\n"
."\n"
.' - ok_alert:地址引用的健康探测模板探测任务部分异常,但地址判定为正常状态。'."\n"
."\n"
.' - ok_no_monitor:地址没有引用任何健康探测模板。'."\n"
."\n"
.' - exceptional:地址引用的健康探测模板探测任务部分或全部异常,且地址判定为异常状态。',
'type' => 'string',
'example' => 'ok',
],
'HealthJudgement' => [
'title' => '地址健康状态判定为ok 的方式:',
'description' => '地址健康状态判定条件:'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'example' => 'p50_ok',
],
'HealthTasks' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HealthTask' => [
'title' => '健康探测任务列表',
'description' => '健康探测任务列表。',
'type' => 'array',
'items' => [
'description' => '地址关联的健康探测任务列表。',
'type' => 'object',
'properties' => [
'Port' => [
'description' => '健康检查探测的目标地址服务端口,当健康检查选择Ping协议时,不支持服务端口的配置。',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
'TemplateId' => [
'description' => '地址关联的健康探测模板ID。',
'type' => 'string',
'example' => 'mtp-89518052425100****',
],
'TemplateName' => [
'description' => '健康探测模板名称。',
'type' => 'string',
'example' => 'Ping-IPv4',
],
'MonitorStatus' => [
'description' => '健康探测模板探测任务状态:'."\n"
.'- ok:正常。'."\n"
."\n"
.'- alert:告警。'."\n"
."\n"
.'- no_data:无数据,一般是健康探测任务刚创建,探测任务数据暂未采集到。',
'type' => 'string',
'example' => 'ok',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 2,\\n \\"TotalItems\\": 30,\\n \\"Addresses\\": {\\n \\"Address\\": [\\n {\\n \\"AddressId\\": \\"addr-89518218114368****\\",\\n \\"CreateTime\\": \\"2024-03-23T13:09Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-29T13:20Z\\",\\n \\"UpdateTimestamp\\": 1527690824357,\\n \\"Name\\": \\"Address-1\\",\\n \\"Type\\": \\"IPv4\\",\\n \\"Address\\": \\"223.5.XX.XX\\",\\n \\"AttributeInfo\\": \\"当前版本不支持此参数,不会返回地址归属信息。\\",\\n \\"Remark\\": \\"app\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"AvailableMode\\": \\"auto\\",\\n \\"ManualAvailableStatus\\": \\"available\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"HealthJudgement\\": \\"p50_ok\\",\\n \\"HealthTasks\\": {\\n \\"HealthTask\\": [\\n {\\n \\"Port\\": 80,\\n \\"TemplateId\\": \\"mtp-89518052425100****\\",\\n \\"TemplateName\\": \\"Ping-IPv4\\",\\n \\"MonitorStatus\\": \\"ok\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取地址列表',
'summary' => '根据传入参数获取地址列表。',
],
'SearchCloudGtmAddresses' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'Names',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '地址名称,一般为方便用户区分的名称。',
'type' => 'array',
'items' => [
'description' => '地址名称搜索条件,支持同时输入多个关键词进行查询。',
'type' => 'string',
'required' => false,
'example' => '["address_1", "test"]',
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'NameSearchCondition',
'in' => 'query',
'schema' => [
'description' => '按地址名称查询时的搜索逻辑(选择地址名称查询时必选参数):'."\n"
."\n"
.'- and:展示输入的搜索条件全部命中的查询结果。'."\n"
."\n"
.'- or:展示输入的搜索条件部分或全部命中的查询结果。',
'type' => 'string',
'required' => false,
'example' => 'or',
],
],
[
'name' => 'AvailableStatus',
'in' => 'query',
'schema' => [
'description' => '按照地址可用状态条件精确搜索:'."\n"
."\n"
.'- available:可用'."\n"
."\n"
.'- unavailable:不可用',
'type' => 'string',
'required' => false,
'example' => 'available',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '地址类型',
'description' => '按照地址类型条件精确搜索:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'required' => false,
'example' => 'IPv4',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'title' => '地址',
'description' => '按照服务地址条件精确查询,支持IP地址或者域名。',
'type' => 'string',
'required' => false,
'example' => '223.5.XX.XX',
],
],
[
'name' => 'MonitorTemplateName',
'in' => 'query',
'schema' => [
'description' => '健康探测模板名称。',
'type' => 'string',
'required' => false,
'example' => 'Ping-IPv4',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '按照地址启用状态进行精确查询:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'HealthStatus',
'in' => 'query',
'schema' => [
'title' => '地址探测结果: ok, ok_alert, ok_no_monitor, exceptional',
'description' => '按照地址健康状态进行精确查询:'."\n"
."\n"
.'- ok:地址引用的健康探测模板探测任务全部正常。'."\n"
."\n"
.'- ok_alert:地址引用的健康探测模板探测任务部分异常,地址判定为正常状态。'."\n"
."\n"
.'- ok_no_monitor:地址没有引用任何健康探测模板。'."\n"
."\n"
.'- exceptional:地址引用的健康探测模板探测任务部分或全部异常,但地址判定为异常状态。',
'type' => 'string',
'required' => false,
'example' => 'ok',
],
],
[
'name' => 'Remarks',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '地址的备注。',
'type' => 'array',
'items' => [
'description' => '地址备注搜索条件,支持同时输入多个关键词进行查询。',
'type' => 'string',
'required' => false,
'example' => '["", "test"]',
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'RemarkSearchCondition',
'in' => 'query',
'schema' => [
'description' => '按地址备注查询时的搜索逻辑(选择地址备注查询时必选参数):'."\n"
."\n"
.'and:展示输入的搜索条件全部命中的查询结果。'."\n"
."\n"
.'or:展示输入的搜索条件部分或全部命中的查询结果。',
'type' => 'string',
'required' => false,
'example' => 'or',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
[
'name' => 'AddressId',
'in' => 'query',
'schema' => [
'description' => '地址ID,地址唯一标识码。',
'type' => 'string',
'required' => false,
'example' => 'addr-89518218114368****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '符合查询条件的地址总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'Addresses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Address' => [
'description' => '地址列表。',
'type' => 'array',
'items' => [
'description' => '地址列表。',
'type' => 'object',
'properties' => [
'AddressId' => [
'title' => '地址 ID',
'description' => '地址的ID,地址唯一标识码。',
'type' => 'string',
'example' => 'addr-89518218114368**92',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '地址的创建时间。',
'type' => 'string',
'example' => '2024-03-23T13:09Z',
],
'CreateTimestamp' => [
'description' => '地址的创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址的最后一次的修改时间。',
'type' => 'string',
'example' => '2024-03-29T13:20Z',
],
'UpdateTimestamp' => [
'description' => '地址的最后一次的修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'Name' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'example' => 'Address-1',
],
'Type' => [
'title' => '地址类型',
'description' => '地址类型:'."\n"
."\n"
.'- IPv4:ipv4地址'."\n"
.'- IPv6:ipv6地址'."\n"
.'- domain:域名',
'type' => 'string',
'example' => 'IPv4',
],
'Address' => [
'title' => '地址',
'description' => 'IP地址或者域名。',
'type' => 'string',
'example' => '223.5.XX.XX',
],
'AttributeInfo' => [
'title' => '地址归属信息',
'description' => '地址归属信息,当前版本不支持此参数。',
'type' => 'string',
'example' => '当前版本不返回此参数。',
],
'Remark' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'example' => 'test',
],
'EnableStatus' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '地址当前启用状态:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'AvailableMode' => [
'title' => '可用状态设置模式',
'description' => '地址探测异常切换方式:'."\n"
."\n"
.'- auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。'."\n"
."\n"
.'- manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。',
'type' => 'string',
'example' => 'auto',
],
'ManualAvailableStatus' => [
'title' => '手动设置的可用状态',
'description' => '当地址探测异常切换模式为manual时,地址设置的可用状态:'."\n"
."\n"
.'- available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'- unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'example' => 'available',
],
'AvailableStatus' => [
'title' => '地址可用状态',
'description' => '当地址探测异常切换模式为manual时,地址设置的可用状态:'."\n"
."\n"
.'- available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'- unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'example' => 'available',
],
'HealthStatus' => [
'title' => '地址的健康状态:',
'description' => '地址健康检查探测结果:'."\n"
."\n"
.'- ok:地址引用的健康探测模板探测任务全部正常;'."\n"
."\n"
.'- ok_alert:地址引用的健康探测模板探测任务部分异常,地址判定为正常状态。'."\n"
."\n"
.'- ok_no_monitor:地址没有引用任何健康探测模板。'."\n"
."\n"
.'- exceptional:地址引用的健康探测模板探测任务部分或全部异常,但地址判定为异常状态。',
'type' => 'string',
'example' => 'ok',
],
'HealthJudgement' => [
'title' => '地址健康状态判定为ok 的方式:',
'description' => '地址健康状态判定条件:'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'example' => 'p50_ok',
],
'HealthTasks' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HealthTask' => [
'title' => '健康探测任务列表',
'description' => '健康探测任务列表。',
'type' => 'array',
'items' => [
'description' => '地址引用的健康探测任务信息。',
'type' => 'object',
'properties' => [
'Port' => [
'description' => '健康检查探测的目标地址服务端口,当健康检查选择Ping协议时,不支持服务端口的配置。',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
'TemplateId' => [
'description' => '地址关联的健康探测模板ID。',
'type' => 'string',
'example' => 'mtp-89518052425100****',
],
'TemplateName' => [
'description' => '健康探测模板名称。',
'type' => 'string',
'example' => 'IPv4-Ping',
],
'MonitorStatus' => [
'description' => '健康探测模板探测任务状态:'."\n"
."\n"
.'- ok:正常。'."\n"
."\n"
.'- alert:告警。'."\n"
."\n"
.'- no_data:无数据,一般是健康探测任务刚创建,探测任务数据暂未采集到。',
'type' => 'string',
'example' => 'ok',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 15,\\n \\"Addresses\\": {\\n \\"Address\\": [\\n {\\n \\"AddressId\\": \\"addr-89518218114368**92\\",\\n \\"CreateTime\\": \\"2024-03-23T13:09Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-29T13:20Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"Name\\": \\"Address-1\\",\\n \\"Type\\": \\"IPv4\\",\\n \\"Address\\": \\"223.5.XX.XX\\",\\n \\"AttributeInfo\\": \\"当前版本不返回此参数。\\",\\n \\"Remark\\": \\"test\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"AvailableMode\\": \\"auto\\",\\n \\"ManualAvailableStatus\\": \\"available\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"HealthJudgement\\": \\"p50_ok\\",\\n \\"HealthTasks\\": {\\n \\"HealthTask\\": [\\n {\\n \\"Port\\": 80,\\n \\"TemplateId\\": \\"mtp-89518052425100****\\",\\n \\"TemplateName\\": \\"IPv4-Ping\\",\\n \\"MonitorStatus\\": \\"ok\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '搜索地址列表',
'summary' => '按照地址名称、备注信息、地址引用的探测模板或地址DI等信息搜索地址列表。',
],
'DescribeCloudGtmAddressReference' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回信息的语言类型:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressId',
'in' => 'query',
'schema' => [
'description' => '地址ID,唯一标识地址。',
'type' => 'string',
'required' => false,
'example' => 'addr-89518218114368****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'AddressId' => [
'title' => '地址 ID',
'description' => '地址ID,唯一标识地址。',
'type' => 'string',
'example' => 'addr-89564584963974****',
],
'Name' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'example' => 'Address-1',
],
'Address' => [
'title' => '地址',
'description' => 'IP地址或域名。',
'type' => 'string',
'example' => '223.5.XX.XX',
],
'AddressPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddressPool' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'description' => '地址池信息。',
'type' => 'object',
'properties' => [
'AddressPoolId' => [
'title' => '地址池Id',
'description' => '地址池ID。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
'AddressPoolName' => [
'title' => '地址池名称',
'description' => '地址池名称。',
'type' => 'string',
'example' => 'AddressPool-1',
],
'InstanceConfigs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceConfig' => [
'description' => '引用地址池的实例列表。',
'type' => 'array',
'items' => [
'description' => '引用地址池的实例配置信息。',
'type' => 'object',
'properties' => [
'InstanceId' => [
'title' => '实例id',
'description' => '全局流量管理3.0实例ID。',
'type' => 'string',
'example' => 'gtm-cn-zz11t58****',
],
'InstanceName' => [
'title' => '调度实例名称',
'description' => '实例名称。',
'type' => 'string',
'example' => 'test',
],
'ConfigId' => [
'title' => '调度实例名称',
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。',
'type' => 'string',
'example' => 'config-00****',
],
'VersionCode' => [
'title' => '调度实例名称',
'description' => '全局流量管理3.0实例版本:'."\n"
."\n"
.'- standard:标准版'."\n"
."\n"
.'- ultimate:旗舰版',
'type' => 'string',
'example' => 'ultimate',
],
'ScheduleZoneName' => [
'title' => 'zone名称',
'description' => 'GTM接入域名的主域(example.com)或子域(a.example.com)。一般为GTM实例所在账号下,在云解析DNS控制台权威解析中托管的域名。',
'type' => 'string',
'example' => 'example.com'."\n",
],
'ScheduleHostname' => [
'title' => '主机记录',
'description' => 'GTM接入域名的主机记录。',
'type' => 'string',
'example' => 'www',
],
'ScheduleDomainName' => [
'title' => '域名,主机记录+zoneNamne',
'description' => 'GTM接入域名。格式为接入域名主机记录(ScheduleHostname参数值)+主域或子域(ScheduleZoneName参数值)',
'type' => 'string',
'example' => 'www.example.com',
],
'ScheduleRrType' => [
'description' => '调度域名的解析记录类型:'."\n"
."\n"
.'- A:IPv4地址'."\n"
."\n"
.'- AAAA:IPv6地址'."\n"
."\n"
.'- CNAME:域名',
'type' => 'string',
'example' => 'A',
],
'Ttl' => [
'description' => '全局TTL(单位:秒),接入域名解析到地址池中地址的TTL值,影响解析记录在运营商LocalDNS中的缓存时间,支持自定义TTL值。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'AddressPoolLbStrategy' => [
'description' => '地址池之间的负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址池。并且每次对于所有地址池进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。若顺序号较小的地址池不可用时,返回下一个序号较小的地址池。'."\n"
."\n"
.'- weight:权重,支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址池,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'description' => '地址池间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址池。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址池。',
'type' => 'string',
'example' => ' preemptive',
],
'AvailableStatus' => [
'description' => '域名实例服务可用状态:'."\n"
."\n"
.'- available:可用,域名**启用**且健康状态为“正常”,接入域名的服务可用状态为**可用**。'."\n"
."\n"
.'- unavailable:不可用,域名**禁用**或健康状态为**异常**,接入域名的服务可用状态为**不可用**。',
'type' => 'string',
'example' => 'available',
],
'EnableStatus' => [
'description' => '域名实例的启用状态:'."\n"
."\n"
.'- enable:启用状态,GTM实例智能调度策略生效。'."\n"
."\n"
.'- disable:禁用状态,GTM实例智能调度策略不可用。',
'type' => 'string',
'example' => 'enable',
],
'HealthStatus' => [
'description' => '域名实例健康状态:'."\n"
."\n"
.'- ok:正常,接入域名引用的所有地址池全部可用。'."\n"
."\n"
.'- ok_alert:警告,接入域名引用的所有地址池部分不可用。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,接入域名引用的所有地址池全部不可用。此时,使用实例所引用的顺序号较小的非空地址池中的地址进行兜底解析,尽可能帮助客户端获得解析结果。',
'type' => 'string',
'example' => 'ok',
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
'AddressPoolType' => [
'description' => '地址池类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'example' => 'IPv4',
],
'AddressLbStrategy' => [
'description' => '地址池中地址间负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址。并且每次对于所有地址进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址(顺序号标识地址返回的优先级,越小优先级越高)。若顺序号较小的地址不可用时,返回下一个序号较小的地址。'."\n"
."\n"
.'- weight:权重,支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'description' => '地址间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址;'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址;',
'type' => 'string',
'example' => 'preemptive',
],
'EnableStatus' => [
'description' => '地址池启用状态:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'HealthJudgement' => [
'description' => '地址池健康状态判定条件:'."\n"
."\n"
.'- any_ok:地址池内至少1个地址是可用地址。'."\n"
."\n"
.'- p30_ok:地址池内至少30%地址是可用地址。'."\n"
."\n"
.'- p50_ok:地址池内至少50%地址是可用地址。'."\n"
."\n"
.'- p70_ok:地址池内至少70%地址是可用地址。'."\n"
."\n"
.'- all_ok:地址池内地址全部可用。',
'type' => 'string',
'example' => 'any_ok',
],
'HealthStatus' => [
'description' => '地址池健康状态:'."\n"
."\n"
.'- ok:正常,地址池引用的所有地址全部可用。'."\n"
."\n"
.'- ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。',
'type' => 'string',
'example' => 'ok',
],
'AvailableStatus' => [
'description' => '地址池可用性状态:'."\n"
."\n"
.'- available:可用'."\n"
."\n"
.'- unavailable:不可用',
'type' => 'string',
'example' => 'available',
],
'Remark' => [
'description' => '地址池的备注。',
'type' => 'string',
'example' => 'pool-1',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"AddressId\\": \\"addr-89564584963974****\\",\\n \\"Name\\": \\"Address-1\\",\\n \\"Address\\": \\"223.5.XX.XX\\",\\n \\"AddressPools\\": {\\n \\"AddressPool\\": [\\n {\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\",\\n \\"AddressPoolName\\": \\"AddressPool-1\\",\\n \\"InstanceConfigs\\": {\\n \\"InstanceConfig\\": [\\n {\\n \\"InstanceId\\": \\"gtm-cn-zz11t58****\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"ConfigId\\": \\"config-00****\\",\\n \\"VersionCode\\": \\"ultimate\\",\\n \\"ScheduleZoneName\\": \\"example.com\\\\n\\",\\n \\"ScheduleHostname\\": \\"www\\",\\n \\"ScheduleDomainName\\": \\"www.example.com\\",\\n \\"ScheduleRrType\\": \\"A\\",\\n \\"Ttl\\": 30,\\n \\"AddressPoolLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\" preemptive\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n },\\n \\"AddressPoolType\\": \\"IPv4\\",\\n \\"AddressLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"Remark\\": \\"pool-1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取地址被引用的信息',
'summary' => '根据传入参数获取地址被引用的地址池、GTM3.0实例信息。',
],
'UpdateCloudGtmAddressEnableStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US:英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressId',
'in' => 'query',
'schema' => [
'title' => '地址 ID',
'description' => '地址的ID,地址唯一标识码。',
'type' => 'string',
'required' => true,
'example' => 'addr-89518218114368****',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'title' => '可用状态',
'description' => '地址启用状态:'."\n"
.'- enable:启用,当前地址健康检查正常的情况下可参与解析。'."\n"
.'- disable: 禁用,当前地址不管健康检查是否正常,均不可参与解析。',
'type' => 'string',
'required' => true,
'example' => 'enable',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Success' => [
'description' => '修改地址启用状态操作是否成功:'."\n"
."\n"
.'- true:操作成功。'."\n"
."\n"
.'- false:操作失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改地址启用状态',
'summary' => '根据传入参数修改地址启用状态。',
'description' => '- 地址**启用**且健康状态为**正常**,地址的服务可用状态为**可用**。'."\n"
."\n"
.'- 地址**禁用**或健康状态为**异常**,地址的服务可用状态为**不可用**。',
],
'UpdateCloudGtmAddressManualAvailableStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressId',
'in' => 'query',
'schema' => [
'title' => '地址 ID',
'description' => '地址的ID,地址唯一标识码。',
'type' => 'string',
'required' => true,
'example' => 'addr-89518218114368****',
],
],
[
'name' => 'AvailableMode',
'in' => 'query',
'schema' => [
'title' => '可用状态设置模式',
'description' => '地址探测异常切换方式:'."\n"
."\n"
.'- auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。'."\n"
."\n"
.'- manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。',
'type' => 'string',
'required' => false,
'example' => 'manual',
],
],
[
'name' => 'ManualAvailableStatus',
'in' => 'query',
'schema' => [
'title' => '可用状态',
'description' => '当地址探测异常切换模式为manual时,地址设置的可用状态:'."\n"
."\n"
.'- available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'- unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'required' => false,
'example' => 'available',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '0F32959D-417B-4D66-8463-68606605E3E2',
],
'Success' => [
'description' => '本次修改操作是否成功:'."\n"
."\n"
.'- true:操作成功。'."\n"
."\n"
.'- false:操作失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F32959D-417B-4D66-8463-68606605E3E2\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改地址探测异常切换方式',
'summary' => '根据传入参数修改地址探测异常切换方式。',
],
'CreateCloudGtmAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressPoolName',
'in' => 'query',
'schema' => [
'description' => '地址池名称,方便用户区分地址池的用途。',
'type' => 'string',
'required' => false,
'example' => 'Address pool-1',
],
],
[
'name' => 'AddressPoolType',
'in' => 'query',
'schema' => [
'description' => '地址池类型:'."\n"
."\n"
.'- IPv4:表示要解析的服务地址是IPv4地址。'."\n"
."\n"
.'- IPv6:表示要解析的服务地址是IPv6地址。'."\n"
."\n"
.'- domain:表示要解析的服务地址是域名。',
'type' => 'string',
'required' => false,
'example' => 'IPv4',
],
],
[
'name' => 'HealthJudgement',
'in' => 'query',
'schema' => [
'description' => '地址池健康状态判定条件:'."\n"
."\n"
.'- any_ok:地址池内至少1个地址是可用地址。'."\n"
."\n"
.'- p30_ok:地址池内至少30%地址是可用地址。'."\n"
."\n"
.'- p50_ok:地址池内至少50%地址是可用地址。'."\n"
."\n"
.'- p70_ok:地址池内至少70%地址是可用地址。'."\n"
."\n"
.'- all_ok:地址池内地址全部可用。',
'type' => 'string',
'required' => false,
'example' => 'any_ok',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'description' => '地址池的启用状态:'."\n"
.'- enable:启用,当前地址池在健康检查正常的情况下可参与解析。'."\n"
.'- disable: 禁用,当前地址池不管健康检查是否正常,均不可参与解析。',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '地址池的备注说明,方便用户区分地址池的使用场景。',
'type' => 'string',
'required' => false,
'example' => 'app',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '46973D4C-E3E4-4ABA-9190-9A9DE406C7E',
],
'Success' => [
'description' => '创建地址池操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
'AddressPoolId' => [
'description' => '生成的地址池ID,地址池的唯一识别码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46973D4C-E3E4-4ABA-9190-9A9DE406C7E\\",\\n \\"Success\\": true,\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\"\\n}","type":"json"}]',
'title' => '创建地址池',
'summary' => '根据传入参数创建地址池。',
],
'ListCloudGtmAddressPools' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'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',
],
],
[
'name' => 'AddressPoolName',
'in' => 'query',
'schema' => [
'description' => '地址池名称。',
'type' => 'string',
'required' => false,
'example' => 'AddressPool-1',
],
],
[
'name' => 'AddressPoolType',
'in' => 'query',
'schema' => [
'description' => '地址池类型:'."\n"
."\n"
.'- IPv4:表示要解析的服务地址是IPv4地址。'."\n"
."\n"
.'- IPv6:表示要解析的服务地址是IPv6地址。'."\n"
."\n"
.'- domain:表示要解析的服务地址是域名。',
'type' => 'string',
'required' => false,
'example' => 'IPv4',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'description' => '地址池启用状态:'."\n"
."\n"
.'- enable:启用状态。'."\n"
."\n"
.'- disable:禁用状态。',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '地址池备注信息。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '地址池总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'AddressPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddressPool' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'description' => '地址池信息。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '地址池创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '地址池创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址池最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '地址池最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357'."\n",
],
'AddressPoolId' => [
'title' => '地址池Id',
'description' => '地址池ID,地址池的唯一标识码。',
'type' => 'string',
'example' => 'pool-89528023225442**16',
],
'AddressPoolName' => [
'title' => '地址池名称',
'description' => '地址池名称。',
'type' => 'string',
'example' => 'AddressPool-1',
],
'AddressPoolType' => [
'title' => '地址池类型ipv4、ipv6、domain',
'description' => '地址池类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'example' => 'IPv4',
],
'AddressLbStrategy' => [
'title' => '地址负载策略',
'description' => '地址池中地址间负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址。并且每次对于所有地址进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址(顺序号标识地址返回的优先级,越小优先级越高)。若顺序号较小的地址不可用时,返回下一个序号较小的地址。'."\n"
."\n"
.'- weight:权重,支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'title' => '顺序负载策略模式(抢占式、非抢占式)',
'description' => '地址间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址。',
'type' => 'string',
'example' => 'preemptive',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '地址池启用状态:'."\n"
."\n"
.'- enable:启用状态。'."\n"
."\n"
.'- disable:禁用状态。',
'type' => 'string',
'example' => 'enable',
],
'HealthJudgement' => [
'title' => '健康判定',
'description' => '地址健康状态判定条件:'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'example' => 'any_ok',
],
'HealthStatus' => [
'title' => '健康状态',
'description' => '地址池健康状态:'."\n"
."\n"
.'- ok:正常,地址池引用的所有地址全部可用。'."\n"
."\n"
.'- ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。',
'type' => 'string',
'example' => 'ok',
],
'AvailableStatus' => [
'title' => '可用性状态',
'description' => '地址池可用性状态:'."\n"
."\n"
.'- available:可用。'."\n"
."\n"
.'- unavailable:不可用。',
'type' => 'string',
'example' => 'available',
],
'Addresses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Address' => [
'description' => '地址列表。',
'type' => 'array',
'items' => [
'description' => '地址信息。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '地址创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '地址创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '地址最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'AddressId' => [
'title' => '地址 ID',
'description' => '地址 ID,地址的唯一标识码。',
'type' => 'string',
'example' => 'addr-89518218114368****',
],
'WeightValue' => [
'title' => '权重',
'description' => '权重值(1-100内的整数),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SerialNumber' => [
'title' => '序号',
'description' => '顺序号,标识地址返回的优先级,越小优先级越高。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestSource' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestSource' => [
'description' => '请求来源列表。',
'type' => 'array',
'items' => [
'description' => '请求来源,是指解析请求的来源,GTM是根据终端所用LocalDNS的出口IP进行调度。若LocalDNS支持ECS (edns-client-subnet),也可以根据访问终端的IP进行智能调度。',
'type' => 'string',
'example' => '["default"]',
],
],
],
],
'Name' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'example' => 'Address-1',
],
'Type' => [
'title' => '地址类型',
'description' => '地址类型:'."\n"
."\n"
.'- IPv4:ipv4地址'."\n"
."\n"
.'- IPv6:ipv6地址'."\n"
."\n"
.'- domain:域名',
'type' => 'string',
'example' => 'IPv4',
],
'Address' => [
'title' => '地址',
'description' => 'IP地址或者域名。',
'type' => 'string',
'example' => '223.5.XX.XX',
],
'AttributeInfo' => [
'title' => '地址归属信息',
'description' => '地址归属信息,当前版本不支持返回此参数。',
'type' => 'string',
'example' => '当前版本不支持返回此参数。',
],
'Remark' => [
'title' => '备注',
'description' => '地址备注。',
'type' => 'string',
'example' => 'test',
],
'EnableStatus' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '地址启用状态:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'AvailableMode' => [
'title' => '可用状态设置模式',
'description' => '地址探测异常切换方式:'."\n"
."\n"
.'- auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。'."\n"
."\n"
.'- manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。',
'type' => 'string',
'example' => 'auto',
],
'ManualAvailableStatus' => [
'title' => '手动设置的可用状态',
'description' => '当地址探测异常切换模式为manual时,地址设置的可用状态:'."\n"
."\n"
.'- available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'- unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'example' => 'available',
],
'AvailableStatus' => [
'title' => '地址可用状态',
'description' => '地址可用状态:'."\n"
."\n"
.'- available:地址可用。'."\n"
."\n"
.'- unavailable:地址不可用。',
'type' => 'string',
'example' => 'available',
],
'HealthStatus' => [
'title' => '地址的健康状态:',
'description' => '地址健康探测状态:'."\n"
."\n"
.'- ok:地址引用的健康探测模板探测任务全部正常。'."\n"
."\n"
.'- ok_alert:地址引用的健康探测模板探测任务部分异常,但地址判定为正常状态。'."\n"
."\n"
.'- ok_no_monitor:地址没有引用任何健康探测模板,状态正常。'."\n"
."\n"
.'- exceptional:地址引用的健康探测模板探测任务部分或全部异常,且地址判定为异常状态。',
'type' => 'string',
'example' => 'ok',
],
'HealthJudgement' => [
'title' => '地址健康状态判定为ok 的方式:',
'description' => '地址健康状态判定条件:'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'example' => 'any_ok',
],
'HealthTasks' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HealthTask' => [
'title' => '健康探测任务列表',
'description' => '健康探测任务列表。',
'type' => 'array',
'items' => [
'description' => '健康探测任务信息。',
'type' => 'object',
'properties' => [
'Port' => [
'description' => '健康检查探测的目标地址服务端口,当健康检查选择Ping协议时,不支持服务端口的配置。',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
'TemplateId' => [
'description' => '健康探测模板ID。',
'type' => 'string',
'example' => 'mtp-89518052425100****',
],
'TemplateName' => [
'description' => '健康探测模板名称。',
'type' => 'string',
'example' => 'IPv4-Ping',
],
],
],
],
],
],
'SeqNonPreemptiveSchedule' => [
'description' => '是否是顺序(非抢占)模式调度对象,针对于融合云纳管场景:'."\n"
."\n"
.'- true:是'."\n"
."\n"
.'- false:不是',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 11,\\n \\"AddressPools\\": {\\n \\"AddressPool\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressPoolId\\": \\"pool-89528023225442**16\\",\\n \\"AddressPoolName\\": \\"AddressPool-1\\",\\n \\"AddressPoolType\\": \\"IPv4\\",\\n \\"AddressLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"Addresses\\": {\\n \\"Address\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressId\\": \\"addr-89518218114368****\\",\\n \\"WeightValue\\": 1,\\n \\"SerialNumber\\": 1,\\n \\"RequestSource\\": {\\n \\"RequestSource\\": [\\n \\"[\\\\\\"default\\\\\\"]\\"\\n ]\\n },\\n \\"Name\\": \\"Address-1\\",\\n \\"Type\\": \\"IPv4\\",\\n \\"Address\\": \\"223.5.XX.XX\\",\\n \\"AttributeInfo\\": \\"当前版本不支持返回此参数。\\",\\n \\"Remark\\": \\"test\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"AvailableMode\\": \\"auto\\",\\n \\"ManualAvailableStatus\\": \\"available\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"HealthTasks\\": {\\n \\"HealthTask\\": [\\n {\\n \\"Port\\": 80,\\n \\"TemplateId\\": \\"mtp-89518052425100****\\",\\n \\"TemplateName\\": \\"IPv4-Ping\\"\\n }\\n ]\\n },\\n \\"SeqNonPreemptiveSchedule\\": false\\n }\\n ]\\n },\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取地址池列表',
'summary' => '获取地址池列表。',
],
'DescribeCloudGtmAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池ID,地址池的唯一标识码。',
'type' => 'string',
'required' => false,
'example' => 'pool-89564674533755****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '地址池创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '地址池创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址池最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '地址池最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'AddressPoolId' => [
'title' => '地址池Id',
'description' => '地址池Id,地址池的唯一标识码。',
'type' => 'string',
'example' => 'pool-89564674533755****',
],
'AddressPoolName' => [
'title' => '地址池名称',
'description' => '地址池名称。',
'type' => 'string',
'example' => 'AddressPool-1',
],
'AddressPoolType' => [
'title' => '地址池类型ipv4、ipv6、domain',
'description' => '地址池类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'example' => 'IPv4',
],
'AddressLbStrategy' => [
'title' => '地址负载策略',
'description' => '地址池中地址间负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址。并且每次对于所有地址进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址(顺序号标识地址返回的优先级,越小优先级越高)。若顺序号较小的地址不可用时,返回下一个序号较小的地址。'."\n"
."\n"
.'- weight:权重,支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'title' => '顺序负载策略模式(抢占式、非抢占式)',
'description' => '地址间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址。',
'type' => 'string',
'example' => 'preemptive',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '地址池启用状态:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'HealthJudgement' => [
'title' => '健康判定',
'description' => '地址池健康状态判定条件:'."\n"
."\n"
.'- any_ok:地址池内至少1个地址是可用地址。'."\n"
."\n"
.'- p30_ok:地址池内至少30%地址是可用地址。'."\n"
."\n"
.'- p50_ok:地址池内至少50%地址是可用地址。'."\n"
."\n"
.'- p70_ok:地址池内至少70%地址是可用地址。'."\n"
."\n"
.'- all_ok:地址池内地址全部可用。',
'type' => 'string',
'example' => 'any_ok',
],
'HealthStatus' => [
'title' => '健康状态',
'description' => '地址池健康状态:'."\n"
."\n"
.'- ok:正常,地址池引用的所有地址全部可用。'."\n"
."\n"
.'- ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。',
'type' => 'string',
'example' => 'ok',
],
'AvailableStatus' => [
'title' => '可用性状态',
'description' => '地址池可用性状态:'."\n"
."\n"
.'- available:可用'."\n"
."\n"
.'- unavailable:不可用',
'type' => 'string',
'example' => 'available',
],
'Addresses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Address' => [
'description' => '地址列表。',
'type' => 'array',
'items' => [
'description' => '地址信息。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '地址创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z'."\n",
],
'CreateTimestamp' => [
'description' => '地址创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z'."\n",
],
'UpdateTimestamp' => [
'description' => '地址的最后一次的修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'AddressId' => [
'title' => '地址 ID',
'description' => '地址 ID,地址的唯一标识码。',
'type' => 'string',
'example' => 'addr-89518218114368****',
],
'WeightValue' => [
'title' => '权重',
'description' => '权重值(1-100内的整数,包括1和100),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SerialNumber' => [
'title' => '序号',
'description' => '顺序号,标识地址返回的优先级,越小优先级越高。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestSource' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RequestSource' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'description' => '请求来源,是指解析请求的来源,GTM是根据终端所用LocalDNS的出口IP进行调度。若LocalDNS支持ECS (edns-client-subnet),也可以根据访问终端的IP进行智能调度。',
'type' => 'string',
'example' => '["default"]',
],
],
],
],
'Name' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'example' => 'Address-1',
],
'Type' => [
'title' => '地址类型',
'description' => '地址类型:'."\n"
."\n"
.'- IPv4:IPv4地址'."\n"
."\n"
.'- IPv6:IPv6地址'."\n"
."\n"
.'- domain:域名',
'type' => 'string',
'example' => 'IPv4',
],
'Address' => [
'description' => 'IP地址或域名。',
'type' => 'string',
'example' => '223.5.XX.XX',
],
'AttributeInfo' => [
'title' => '地址归属信息',
'description' => '地址归属信息,当前版本不支持返回此参数。',
'type' => 'string',
'example' => '当前版本不支持返回此参数。',
],
'Remark' => [
'title' => '备注',
'description' => '地址的备注。',
'type' => 'string',
'example' => 'test',
],
'EnableStatus' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '地址启用状态,表示地址当前是否可用:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'AvailableMode' => [
'title' => '可用状态设置模式',
'description' => '地址探测异常切换方式:'."\n"
."\n"
.'- auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。'."\n"
."\n"
.'- manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。',
'type' => 'string',
'example' => 'auto',
],
'ManualAvailableStatus' => [
'title' => '手动设置的可用状态',
'description' => '当地址探测异常切换模式为manual时,地址设置的可用状态:'."\n"
."\n"
.'- available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'- unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'example' => 'available',
],
'AvailableStatus' => [
'title' => '地址可用状态',
'description' => '地址可用状态:'."\n"
."\n"
.'- available:地址可用'."\n"
."\n"
.'- unavailable:地址不可用',
'type' => 'string',
'example' => 'available',
],
'HealthStatus' => [
'title' => '地址的健康状态:',
'description' => '地址健康探测状态:'."\n"
."\n"
.'- ok:地址引用的健康探测模板探测任务全部正常。'."\n"
."\n"
.'- ok_alert:地址引用的健康探测模板探测任务部分异常,但地址判定为正常状态。'."\n"
."\n"
.'- ok_no_monitor:地址没有引用任何健康探测模板,状态正常。'."\n"
."\n"
.'- exceptional:地址引用的健康探测模板探测任务部分或全部异常,且地址判定为异常状态。',
'type' => 'string',
'example' => 'ok',
],
'HealthJudgement' => [
'title' => '地址健康状态判定为ok 的方式:',
'description' => '地址健康状态判定条件:'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'example' => 'any_ok',
],
'HealthTasks' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HealthTask' => [
'title' => '健康探测任务列表',
'description' => '健康探测任务列表。',
'type' => 'array',
'items' => [
'description' => '健康探测任务配置。',
'type' => 'object',
'properties' => [
'Port' => [
'description' => '健康检查探测的目标地址服务端口,当健康检查选择Ping协议时,不支持服务端口的配置。',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
'TemplateId' => [
'description' => '地址关联的健康探测模板ID。',
'type' => 'string',
'example' => 'mtp-89518052425100**80'."\n",
],
'TemplateName' => [
'description' => '健康探测模板名称。',
'type' => 'string',
'example' => 'IPv4-Ping',
],
],
],
],
],
],
'SeqNonPreemptiveSchedule' => [
'description' => '是否是顺序(非抢占)模式调度对象,针对于融合云纳管场景:'."\n"
."\n"
.'- true:是'."\n"
."\n"
.'- false:不是',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
'Remark' => [
'description' => '地址的备注。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressPoolId\\": \\"pool-89564674533755****\\",\\n \\"AddressPoolName\\": \\"AddressPool-1\\",\\n \\"AddressPoolType\\": \\"IPv4\\",\\n \\"AddressLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"Addresses\\": {\\n \\"Address\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\\\n\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\\\n\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressId\\": \\"addr-89518218114368****\\",\\n \\"WeightValue\\": 1,\\n \\"SerialNumber\\": 1,\\n \\"RequestSource\\": {\\n \\"RequestSource\\": [\\n \\"[\\\\\\"default\\\\\\"]\\"\\n ]\\n },\\n \\"Name\\": \\"Address-1\\",\\n \\"Type\\": \\"IPv4\\",\\n \\"Address\\": \\"223.5.XX.XX\\",\\n \\"AttributeInfo\\": \\"当前版本不支持返回此参数。\\",\\n \\"Remark\\": \\"test\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"AvailableMode\\": \\"auto\\",\\n \\"ManualAvailableStatus\\": \\"available\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"HealthTasks\\": {\\n \\"HealthTask\\": [\\n {\\n \\"Port\\": 80,\\n \\"TemplateId\\": \\"mtp-89518052425100**80\\\\n\\",\\n \\"TemplateName\\": \\"IPv4-Ping\\"\\n }\\n ]\\n },\\n \\"SeqNonPreemptiveSchedule\\": false\\n }\\n ]\\n },\\n \\"Remark\\": \\"test\\"\\n}","type":"json"}]',
'title' => '获取地址池配置信息',
'summary' => '根据传入参数获取指定地址池配置信息。',
],
'DeleteCloudGtmAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池ID,地址池的唯一识别码。',
'type' => 'string',
'required' => false,
'example' => 'pool-89528023225442****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Success' => [
'description' => '删除地址池操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
'AddressPoolId' => [
'description' => '地址池ID,地址池的唯一识别码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Success\\": true,\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\"\\n}","type":"json"}]',
'title' => '删除地址池',
'summary' => '根据传入参数删除地址池。',
],
'SearchCloudGtmAddressPools' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****'."\n",
],
],
[
'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',
],
],
[
'name' => 'AddressPoolName',
'in' => 'query',
'schema' => [
'description' => '地址池名称,支持对输入的地址池名称进行模糊搜索。',
'type' => 'string',
'required' => false,
'example' => 'AddressPool-1',
],
],
[
'name' => 'AddressPoolType',
'in' => 'query',
'schema' => [
'description' => '地址池类型,支持对地址池类型进行精确查询:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'required' => false,
'example' => 'IPv4',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'description' => '地址池启用状态,支持对地址池启用状态进行精确查询:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '地址池备注,支持对输入的备注进行模糊搜索。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'HealthStatus',
'in' => 'query',
'schema' => [
'description' => '地址池健康状态,支持对地址池健康状态精确查询:'."\n"
."\n"
.'ok:正常,地址池引用的所有地址全部可用。'."\n"
."\n"
.'ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。',
'type' => 'string',
'required' => false,
'example' => 'ok',
],
],
[
'name' => 'AvailableStatus',
'in' => 'query',
'schema' => [
'description' => '地址池可用状态,支持对地址池可用状态进行精确查询:'."\n"
."\n"
.'- available:可用'."\n"
."\n"
.'- unavailable:不可用',
'type' => 'string',
'required' => false,
'example' => 'available',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '符合查询条件的地址池总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'AddressPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddressPool' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'description' => '地址池信息。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '地址池创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '地址池创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址池最后一次修改时间。',
'type' => 'string',
'example' => '024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '地址池最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'AddressPoolId' => [
'title' => '地址池Id',
'description' => '地址池ID,地址池的唯一标识码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
'AddressPoolName' => [
'title' => '地址池名称',
'description' => '地址池名称。',
'type' => 'string',
'example' => 'AddressPool-1',
],
'AddressPoolType' => [
'title' => '地址池类型ipv4、ipv6、domain',
'description' => '地址池类型:'."\n"
."\n"
.'- IPv4'."\n"
."\n"
.'- IPv6'."\n"
."\n"
.'- domain',
'type' => 'string',
'example' => 'IPv4',
],
'AddressLbStrategy' => [
'title' => '地址负载策略',
'description' => '地址池中地址间负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址。并且每次对于所有地址进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址(顺序号标识地址返回的优先级,越小优先级越高)。若顺序号较小的地址不可用时,返回下一个序号较小的地址。'."\n"
."\n"
.'- weight:权重,支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'title' => '顺序负载策略模式(抢占式、非抢占式)',
'description' => '地址间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址。',
'type' => 'string',
'example' => 'preemptive',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '地址池启用状态:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'HealthJudgement' => [
'title' => '健康判定',
'description' => '地址池健康状态判定条件:'."\n"
."\n"
.'- any_ok:地址池内至少1个地址是可用地址。'."\n"
."\n"
.'- p30_ok:地址池内至少30%地址是可用地址。'."\n"
."\n"
.'- p50_ok:地址池内至少50%地址是可用地址。'."\n"
."\n"
.'- p70_ok:地址池内至少70%地址是可用地址。'."\n"
."\n"
.'- all_ok:地址池内地址全部可用。',
'type' => 'string',
'example' => 'any_ok',
],
'HealthStatus' => [
'title' => '健康状态',
'description' => '地址池健康状态:'."\n"
."\n"
.'- ok:正常,地址池引用的所有地址全部可用。'."\n"
."\n"
.'- ok_alert:警告,地址池引用的地址部分不可用,但是地址池状态判定为正常。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,地址池引用的地址部分或全部不可用,地址池状态判定为异常。',
'type' => 'string',
'example' => 'ok',
],
'AvailableStatus' => [
'title' => '可用性状态',
'description' => '地址池可用性状态:'."\n"
."\n"
.'- available:可用'."\n"
."\n"
.'- unavailable:不可用',
'type' => 'string',
'example' => 'available',
],
'Addresses' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Address' => [
'description' => 'IP地址或者域名列表。',
'type' => 'array',
'items' => [
'description' => 'IP地址或者域名信息。',
'type' => 'object',
'properties' => [
'CreateTime' => [
'title' => '创建时间',
'description' => '地址创建时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'CreateTimestamp' => [
'description' => '地址创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '地址最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-15T01:46Z',
],
'UpdateTimestamp' => [
'description' => '地址的最后一次的修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357'."\n",
],
'AddressId' => [
'title' => '地址 ID',
'description' => '地址 ID,地址的唯一标识码。',
'type' => 'string',
'example' => 'addr-89518218114368****',
],
'WeightValue' => [
'title' => '权重',
'description' => '权重值(1-100内的整数),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SerialNumber' => [
'title' => '序号',
'description' => '顺序号,标识地址返回的优先级,越小优先级越高。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestSource' => [
'title' => '请求来源',
'description' => '请求来源,是指解析请求的来源,GTM是根据终端所用LocalDNS的出口IP进行调度。若LocalDNS支持ECS (edns-client-subnet),也可以根据访问终端的IP进行智能调度。',
'type' => 'string',
'example' => 'default',
],
'Name' => [
'title' => '地址名称',
'description' => '地址名称。',
'type' => 'string',
'example' => 'Address-1',
],
'Type' => [
'title' => '地址类型',
'description' => '地址类型:'."\n"
."\n"
.'- IPv4:ipv4地址'."\n"
.'- IPv6:ipv6地址'."\n"
.'- domain:域名',
'type' => 'string',
'example' => 'IPv4',
],
'Address' => [
'title' => '地址',
'description' => 'IP地址或者域名。',
'type' => 'string',
'example' => '223.5.XX.XX',
],
'AttributeInfo' => [
'title' => '地址归属信息',
'description' => '地址归属信息,当前版本不支持返回此参数。',
'type' => 'string',
'example' => '当前版本不支持返回此参数。',
],
'Remark' => [
'title' => '备注',
'description' => '备注。',
'type' => 'string',
'example' => 'test',
],
'EnableStatus' => [
'title' => '启用状态 enable: 可用, disable:不可用',
'description' => '地址启用状态,表示地址当前是否可用:'."\n"
."\n"
.'- enable:启用状态'."\n"
."\n"
.'- disable:禁用状态',
'type' => 'string',
'example' => 'enable',
],
'AvailableMode' => [
'title' => '可用状态设置模式',
'description' => '地址探测异常切换方式:'."\n"
."\n"
.'- auto:自动模式(根据健康检查探测结果确定,探测异常停止解析,探测正常恢复解析)。'."\n"
."\n"
.'- manual:手动模式(异常状态下停止解析,健康检查正常也不会恢复解析;正常状态下恢复解析,健康检查异常也只是告警,但不会停止解析)。',
'type' => 'string',
'example' => 'auto',
],
'ManualAvailableStatus' => [
'title' => '手动设置的可用状态',
'description' => '当地址探测异常切换模式为manual时,地址设置的可用状态:'."\n"
."\n"
.'- available:正常,此状态下该地址正常解析,健康检查异常也只是告警,但不会停止解析。'."\n"
."\n"
.'- unavailable:异常,此状态下停止解析,健康检查正常也不会恢复解析。',
'type' => 'string',
'example' => 'available',
],
'AvailableStatus' => [
'title' => '地址可用状态',
'description' => '地址可用状态:'."\n"
."\n"
.'- available:地址可用'."\n"
."\n"
.'- unavailable:地址不可用',
'type' => 'string',
'example' => 'available',
],
'HealthStatus' => [
'title' => '地址的健康状态:',
'description' => '地址健康探测状态:'."\n"
."\n"
.'- ok:地址引用的健康探测模板探测任务全部正常。'."\n"
."\n"
.'- ok_alert:地址引用的健康探测模板探测任务部分异常,但地址判定为正常状态。'."\n"
."\n"
.'- ok_no_monitor:地址没有引用任何健康探测模板,状态正常。'."\n"
."\n"
.'- exceptional:地址引用的健康探测模板探测任务部分或全部异常,且地址判定为异常状态。',
'type' => 'string',
'example' => 'ok',
],
'HealthJudgement' => [
'title' => '地址健康状态判定为ok 的方式:',
'description' => '地址健康状态判定条件:'."\n"
."\n"
.'- any_ok:所有探测模板至少一个探测正常。'."\n"
."\n"
.'- p30_ok:所有探测模板至少30%探测正常。'."\n"
."\n"
.'- p50_ok:所有探测模板至少50%探测正常。'."\n"
."\n"
.'- p70_ok:所有探测模板至少70%探测正常。'."\n"
."\n"
.'- all_ok:所有探测模板全部探测正常。',
'type' => 'string',
'example' => 'any_ok',
],
'HealthTasks' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HealthTask' => [
'title' => '健康探测任务列表',
'description' => '健康探测任务列表。',
'type' => 'array',
'items' => [
'description' => '健康探测任务信息。',
'type' => 'object',
'properties' => [
'Port' => [
'description' => '健康检查探测的目标地址服务端口,当健康检查选择Ping协议时,不支持服务端口的配置。',
'type' => 'integer',
'format' => 'int32',
'example' => '80',
],
'TemplateId' => [
'description' => '地址关联的健康探测模板ID。',
'type' => 'string',
'example' => 'mtp-89518052425100****',
],
'TemplateName' => [
'description' => '健康探测模板名称。',
'type' => 'string',
'example' => 'IPv4-Ping',
],
],
],
],
],
],
],
],
],
],
],
'Remark' => [
'description' => '地址备注。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 11,\\n \\"AddressPools\\": {\\n \\"AddressPool\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\",\\n \\"AddressPoolName\\": \\"AddressPool-1\\",\\n \\"AddressPoolType\\": \\"IPv4\\",\\n \\"AddressLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"Addresses\\": {\\n \\"Address\\": [\\n {\\n \\"CreateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-15T01:46Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AddressId\\": \\"addr-89518218114368****\\",\\n \\"WeightValue\\": 1,\\n \\"SerialNumber\\": 1,\\n \\"RequestSource\\": \\"default\\",\\n \\"Name\\": \\"Address-1\\",\\n \\"Type\\": \\"IPv4\\",\\n \\"Address\\": \\"223.5.XX.XX\\",\\n \\"AttributeInfo\\": \\"当前版本不支持返回此参数。\\",\\n \\"Remark\\": \\"test\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"AvailableMode\\": \\"auto\\",\\n \\"ManualAvailableStatus\\": \\"available\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"HealthJudgement\\": \\"any_ok\\",\\n \\"HealthTasks\\": {\\n \\"HealthTask\\": [\\n {\\n \\"Port\\": 80,\\n \\"TemplateId\\": \\"mtp-89518052425100****\\",\\n \\"TemplateName\\": \\"IPv4-Ping\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '搜索地址池列表',
'summary' => '根据传入参数搜索地址池列表。',
],
'ReplaceCloudGtmInstanceConfigAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****'."\n",
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => '调度实例id',
'description' => '需要替换地址池的GTM 3.0实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3hb****',
],
],
[
'name' => 'AddressPools',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'description' => '地址池信息。',
'type' => 'object',
'properties' => [
'AddressPoolId' => [
'description' => '地址池ID,地址池的唯一标识码。'."\n"
."\n"
.'- 该参数不为空时,目标实例关联的地址池将会被删除,会全部替换为更新后的地址池。'."\n"
."\n"
.'- 该参数为空时,目标实例引用的地址池全部删除,实例无关联的地址池。',
'type' => 'string',
'required' => false,
'example' => 'pool-89564542105737****',
],
'WeightValue' => [
'title' => '权重值',
'description' => '权重值(1-100之间的整数,包括1和100),支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。配置参数对更新后的地址池生效。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'SerialNumber' => [
'title' => '序号',
'description' => '顺序号,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。配置参数对更新后的地址池生效。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'RequestSource' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'description' => '请求来源,是指解析请求的来源,GTM是根据终端所用LocalDNS的出口IP进行调度。若LocalDNS支持ECS (edns-client-subnet),也可以根据访问终端的IP进行智能调度。配置参数对更新后的地址池生效。',
'type' => 'string',
'required' => false,
'example' => '["default"]',
],
'required' => false,
'maxItems' => 100,
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。'."\n"
."\n"
.'调用 [ListCloudGtmInstanceConfigs](~~2797349~~) 接口可查询域名实例对应的 ConfigId 值。',
'type' => 'string',
'required' => false,
'example' => 'Config-000****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Success' => [
'description' => '本次操作是否成功,取值:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '替换实例关联的地址池',
'summary' => '根据传入参数替换实例关联的地址池。',
],
'UpdateCloudGtmAddressPoolEnableStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池的ID,地址池的唯一识别码。',
'type' => 'string',
'required' => false,
'example' => 'pool-89528023225442****',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'description' => '地址池的启用状态:'."\n"
.'- enable:启用,当前地址池在健康检查正常的情况下可参与解析。'."\n"
.'- disable: 禁用,当前地址池不管健康检查是否正常,均不可参与解析。',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '89184F33-48A1-4401-9C0F-40E45DB091AB',
],
'Success' => [
'description' => '本次修改操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
'AddressPoolId' => [
'description' => '地址池的ID,地址池的唯一识别码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89184F33-48A1-4401-9C0F-40E45DB091AB\\",\\n \\"Success\\": true,\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\"\\n}","type":"json"}]',
'title' => '修改地址池启用状态',
'summary' => '根据传入参数修改地址池启用状态。',
'description' => '- 地址池**启用**且健康状态为**正常**,地址池的服务可用状态为**可用**。'."\n"
."\n"
.'- 地址池**禁用**或健康状态为**异常**,地址池的服务可用状态为**不可用**。',
],
'UpdateCloudGtmAddressPoolRemark' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池的ID,地址池的唯一识别码。',
'type' => 'string',
'required' => false,
'example' => 'pool-89528023225442****',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '传入的参数作为更新后的备注,传空值则删除备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Success' => [
'description' => '本次修改操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
'AddressPoolId' => [
'description' => '地址池的ID,地址池的唯一识别码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Success\\": true,\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\"\\n}","type":"json"}]',
'title' => '修改地址池备注',
'summary' => '根据传入参数修改地址池备注信息。',
],
'UpdateCloudGtmAddressPoolLbStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池ID,地址池的唯一识别码。',
'type' => 'string',
'required' => false,
'example' => 'pool-89528023225442****',
],
],
[
'name' => 'AddressLbStrategy',
'in' => 'query',
'schema' => [
'description' => '地址池中地址间负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址。并且每次对于所有地址进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址(顺序号标识地址返回的优先级,越小优先级越高)。若顺序号较小的地址不可用时,返回下一个序号较小的地址。'."\n"
."\n"
.'- weight:权重,支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址,实现用户就近访问的效果。',
'type' => 'string',
'required' => false,
'example' => 'sequence',
],
],
[
'name' => 'SequenceLbStrategyMode',
'in' => 'query',
'schema' => [
'description' => '地址间负载均衡策略取值为sequence(顺序模式)时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址。',
'type' => 'string',
'required' => false,
'example' => 'preemptive',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'Success' => [
'description' => '本次修改操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
'AddressPoolId' => [
'description' => '地址池ID,地址池的唯一识别码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"Success\\": true,\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\"\\n}","type":"json"}]',
'title' => '修改地址池负载均衡策略',
'summary' => '根据传入参数修改地址池负载均衡策略。',
],
'UpdateCloudGtmAddressPoolBasicConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池ID,地址池的唯一识别码。',
'type' => 'string',
'required' => false,
'example' => 'pool-89528023225442****',
],
],
[
'name' => 'AddressPoolName',
'in' => 'query',
'schema' => [
'description' => '地址池名称,方便用户区分地址池的用途。',
'type' => 'string',
'required' => false,
'example' => 'app',
],
],
[
'name' => 'HealthJudgement',
'in' => 'query',
'schema' => [
'description' => '地址池健康状态判定条件:'."\n"
."\n"
.'- any_ok:地址池内至少1个地址是可用地址。'."\n"
."\n"
.'- p30_ok:地址池内至少30%地址是可用地址。'."\n"
."\n"
.'- p50_ok:地址池内至少50%地址是可用地址。'."\n"
."\n"
.'- p70_ok:地址池内至少70%地址是可用地址。'."\n"
."\n"
.'- all_ok:地址池内地址全部可用。',
'type' => 'string',
'required' => false,
'example' => 'any_ok',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Success' => [
'description' => '修改地址池基础配置操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
'AddressPoolId' => [
'description' => '地址池ID,地址池的唯一识别码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Success\\": true,\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\"\\n}","type":"json"}]',
'title' => '修改地址池基础配置',
'summary' => '根据传入参数修改地址池基础配置。',
],
'ReplaceCloudGtmAddressPoolAddress' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回的语言。取值:'."\n"
."\n"
.'- **zh-CN**:中文'."\n"
."\n"
.'- **en-US**(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'AddressPoolId',
'in' => 'query',
'schema' => [
'description' => '需要更新地址的目标地址池ID,地址池的唯一标识码。',
'type' => 'string',
'required' => false,
'example' => 'pool-89618921167339****',
],
],
[
'name' => 'Addresses',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '地址列表。',
'type' => 'array',
'items' => [
'description' => '地址信息。',
'type' => 'object',
'properties' => [
'AddressId' => [
'title' => '地址id',
'description' => '更新后的地址ID,地址的唯一标识码。'."\n"
."\n"
.'- 该参数不为空时,地址池中原有的地址将会被删除,会全部替换为更新后的地址。'."\n"
."\n"
.'- 该参数为空时,地址池中原有的地址均被删除,会将地址池置空。',
'type' => 'string',
'required' => false,
'example' => 'addr-89636516932803****',
],
'WeightValue' => [
'title' => '权重值',
'description' => '权重值(1-100内的整数,包括1和100),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。对更新后的地址配置生效。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'SerialNumber' => [
'title' => '序号',
'description' => '顺序号,标识地址返回的优先级,越小优先级越高。对更新后的地址配置生效。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'RequestSource' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'description' => '请求来源,是指解析请求的来源,GTM是根据终端所用LocalDNS的出口IP进行调度。若LocalDNS支持ECS (edns-client-subnet),也可以根据访问终端的IP进行智能调度。对更新后的地址配置生效。',
'type' => 'string',
'required' => false,
'example' => '["default"]',
],
'required' => false,
'maxItems' => 100,
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'AddressPoolId' => [
'description' => '地址池ID,地址池的唯一标识码。',
'type' => 'string',
'example' => 'pool-89618921167339****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"Success\\": true,\\n \\"AddressPoolId\\": \\"pool-89618921167339****\\"\\n}","type":"json"}]',
'title' => '替换地址池引用的地址',
'summary' => '根据传入参数替换地址池引用的地址。',
],
'DescribeCloudGtmAddressPoolReference' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****'."\n",
],
],
[
'name' => 'AddressPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池ID,地址池的唯一识别码。',
'type' => 'string',
'required' => false,
'example' => 'pool-89528023225442****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '853805EA-3D47-47D5-9A1A-A45C24313ABD',
],
'AddressPoolId' => [
'title' => '地址池 ID',
'description' => '地址池ID,地址池的唯一识别码。',
'type' => 'string',
'example' => 'pool-89528023225442****',
],
'AddressPoolName' => [
'title' => '地址池名称',
'description' => '地址池名称。',
'type' => 'string',
'example' => 'app',
],
'InstanceConfigs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InstanceConfig' => [
'description' => '引用地址池的实例列表。',
'type' => 'array',
'items' => [
'description' => '引用地址池的实例。',
'type' => 'object',
'properties' => [
'InstanceId' => [
'title' => '实例id',
'description' => '全局流量管理3.0实例ID。',
'type' => 'string',
'example' => 'gtm-cn-jmp3qnw****',
],
'ConfigId' => [
'title' => '实例id',
'description' => '域名实例配置ID,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。',
'type' => 'string',
'example' => 'config-00****',
],
'VersionCode' => [
'title' => '实例id',
'description' => '全局流量管理3.0实例版本:'."\n"
."\n"
.'- standard:标准版'."\n"
."\n"
.'- ultimate:旗舰版',
'type' => 'string',
'example' => 'ultimate',
],
'InstanceName' => [
'title' => '调度实例名称',
'description' => '实例名称。',
'type' => 'string',
'example' => 'test',
],
'ScheduleZoneName' => [
'title' => 'zone名称',
'description' => 'GTM接入域名的主域(example.com)或子域(a.example.com)。一般为GTM实例所在账号下,在云解析DNS控制台权威解析中托管的域名。',
'type' => 'string',
'example' => 'example.com',
],
'ScheduleHostname' => [
'title' => '主机记录',
'description' => 'GTM接入域名的主机记录。',
'type' => 'string',
'example' => 'www',
],
'ScheduleDomainName' => [
'title' => '域名,主机记录+zoneNamne',
'description' => 'GTM接入域名。格式为接入域名主机记录(ScheduleHostname参数值)+主域或子域(ScheduleZoneName参数值)。',
'type' => 'string',
'example' => 'www.example.com',
],
'ScheduleRrType' => [
'description' => '调度域名的解析记录类型:'."\n"
."\n"
.'- A:IPv4地址'."\n"
."\n"
.'- AAAA:IPv6地址'."\n"
."\n"
.'- CNAME:域名',
'type' => 'string',
'example' => 'A',
],
'Ttl' => [
'description' => '全局TTL,接入域名解析到地址池中地址的TTL值,影响解析记录在运营商LocalDNS中的缓存时间,支持自定义TTL值。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'AddressPoolLbStrategy' => [
'description' => '地址池之间的负载均衡策略:'."\n"
."\n"
.'- round_robin:轮询,对于任何来源的解析请求,返回所有地址池。并且每次对于所有地址池进行轮转排序。'."\n"
."\n"
.'- sequence:顺序,对于任何来源的解析请求,返回顺序号较小的地址池(顺序号标识地址池返回的优先级,越小优先级越高)。若顺序号较小的地址池不可用时,返回下一个序号较小的地址池。'."\n"
."\n"
.'- weight:权重,支持对每个地址池设置不同的权重值,实现解析查询按照权重比例返回地址池。'."\n"
."\n"
.'- source_nearest:来源就近,即智能解析功能,GTM可以根据不同的解析请求来源返回不同的地址池,实现用户就近访问的效果。',
'type' => 'string',
'example' => 'round_robin',
],
'SequenceLbStrategyMode' => [
'description' => '地址池间负载均衡策略为顺序模式时,前序资源异常恢复服务模式:'."\n"
."\n"
.'- preemptive:抢占模式,前序资源恢复,优先使用顺序号较小的地址池。'."\n"
."\n"
.'- non_preemptive:非抢占模式,前序资源恢复,仍然使用当前地址池。',
'type' => 'string',
'example' => 'preemptive',
],
'AvailableStatus' => [
'description' => '域名实例服务可用状态:'."\n"
."\n"
.'- available:可用,域名**启用**且健康状态为**正常**,接入域名的服务可用状态为**可用**。'."\n"
."\n"
.'- unavailable:不可用,域名**禁用**或健康状态为**异常**,接入域名的服务可用状态为**不可用**。',
'type' => 'string',
'example' => 'available',
],
'EnableStatus' => [
'description' => '域名实例的启用状态:'."\n"
."\n"
.'- enable:启用状态,GTM实例智能调度策略生效。'."\n"
."\n"
.'- disable:禁用状态,GTM实例智能调度策略不可用。',
'type' => 'string',
'example' => 'enable',
],
'HealthStatus' => [
'description' => '域名实例健康状态:'."\n"
."\n"
.'- ok:正常,接入域名引用的所有地址池全部可用。'."\n"
."\n"
.'- ok_alert:警告,接入域名引用的所有地址池部分不可用。警告状态下,可用的地址池正常解析,不可用的地址池停止解析。'."\n"
."\n"
.'- exceptional:异常,接入域名引用的所有地址池全部不可用。此时,使用实例所引用的顺序号较小的非空地址池中的地址进行兜底解析,尽可能帮助客户端获得解析结果。',
'type' => 'string',
'example' => 'ok',
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"853805EA-3D47-47D5-9A1A-A45C24313ABD\\",\\n \\"AddressPoolId\\": \\"pool-89528023225442****\\",\\n \\"AddressPoolName\\": \\"app\\",\\n \\"InstanceConfigs\\": {\\n \\"InstanceConfig\\": [\\n {\\n \\"InstanceId\\": \\"gtm-cn-jmp3qnw****\\",\\n \\"ConfigId\\": \\"config-00****\\",\\n \\"VersionCode\\": \\"ultimate\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"ScheduleZoneName\\": \\"example.com\\",\\n \\"ScheduleHostname\\": \\"www\\",\\n \\"ScheduleDomainName\\": \\"www.example.com\\",\\n \\"ScheduleRrType\\": \\"A\\",\\n \\"Ttl\\": 30,\\n \\"AddressPoolLbStrategy\\": \\"round_robin\\",\\n \\"SequenceLbStrategyMode\\": \\"preemptive\\",\\n \\"AvailableStatus\\": \\"available\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"HealthStatus\\": \\"ok\\",\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取地址池被实例引用的信息',
'summary' => '根据传入参数获取地址池被实例引用的信息。',
],
'SearchCloudGtmMonitorTemplates' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '健康探测模板的名称,按照输入的关键字进行模糊搜索。',
'type' => 'string',
'required' => false,
'example' => 'IPv4-Ping'."\n",
],
],
[
'name' => 'IpVersion',
'in' => 'query',
'schema' => [
'description' => '按照探测节点IP地址的类型进行精确搜索:'."\n"
."\n"
.'- IPv4:当探测的目标地址类型为IPv4地址时适用。'."\n"
."\n"
.'- IPv6:当探测的目标地址类型为IPv6地址时适用。',
'type' => 'string',
'required' => false,
'example' => 'IPv4',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '按照探测协议类型进行精确搜索:'."\n"
."\n"
.'- ping'."\n"
."\n"
.'- tcp'."\n"
."\n"
.'- http'."\n"
."\n"
.'- https',
'type' => 'string',
'required' => false,
'example' => 'ping',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '搜索到的健康探测模板总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Templates' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Template' => [
'description' => '健康探测模板列表。',
'type' => 'array',
'items' => [
'description' => '健康探测模板信息。',
'type' => 'object',
'properties' => [
'TemplateId' => [
'title' => '模板 ID ,全局唯一',
'description' => '健康探测模板ID,唯一标识健康探测模板。',
'type' => 'string',
'example' => 'mtp-89518052425100**80',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '健康探测模板的创建时间。',
'type' => 'string',
'example' => '2024-03-23T13:09Z',
],
'CreateTimestamp' => [
'description' => '健康探测模板的创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '健康探测模板的最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-29T13:20Z',
],
'UpdateTimestamp' => [
'description' => '健康探测模板的最后一次修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'Name' => [
'title' => '探测模板名称',
'description' => '健康检查探测模板的名称,一般为了方便配置人员区分和记忆,建议名称可以区分健康检查协议。',
'type' => 'string',
'example' => 'IPv4-Ping',
],
'IpVersion' => [
'title' => '探测的网络环境 IP 版本',
'description' => '探测节点IP地址的类型:'."\n"
."\n"
.'- IPv4:当探测的目标地址类型为IPv4地址时适用。'."\n"
.'- IPv6:当探测的目标地址类型为IPv6地址时适用。',
'type' => 'string',
'example' => 'IPv4',
],
'Protocol' => [
'title' => '探测协议',
'description' => '对目标IP地址发起探测的协议类型:'."\n"
."\n"
.'- ping'."\n"
."\n"
.'- tcp'."\n"
."\n"
.'- http'."\n"
."\n"
.'- https',
'type' => 'string',
'example' => 'ping',
],
'Interval' => [
'title' => '探测间隔(秒)',
'description' => '每次检查的时间间隔(秒),默认每间隔1分钟探测一次,健康检查间隔最小支持15秒(面向旗舰版实例开放)。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Timeout' => [
'title' => '探测超时时间',
'description' => '探测超时时间(毫秒),大于超时时间未返回的数据包即判断为健康检查超时:'."\n"
."\n"
.'- 2000'."\n"
."\n"
.'- 3000'."\n"
."\n"
.'- 5000'."\n"
."\n"
.'- 10000',
'type' => 'integer',
'format' => 'int32',
'example' => '5000',
],
'EvaluationCount' => [
'title' => '探测连续次数',
'description' => '重试次数,连续多次监控出现异常,系统才将应用服务判断为异常,以防止因为一些网络瞬间抖动等其他原因影响监控准确率。重试次数可选值为:'."\n"
."\n"
.'- 1'."\n"
."\n"
.'- 2'."\n"
."\n"
.'- 3',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'FailureRate' => [
'title' => '告警失败率',
'description' => '所选节点探测失败比例(%),即健康检查异常的探测点占探测点总数的百分比,当失败比例超过设置的阈值时,将服务地址判断为异常。可设置的失败比例阈值为:'."\n"
."\n"
.'- 20'."\n"
."\n"
.'- 50'."\n"
."\n"
.'- 80'."\n"
."\n"
.'- 100',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'ExtendInfo' => [
'description' => 'Json 字符串扩展信息,各协议检查所需参数:'."\n"
."\n"
.'- **http(s)**:'."\n"
."\n"
.' **host**:执行HTTP(S)监控时,指定HTTP(S)请求头部信息中携带的Host字段,用于标识需要访问的具体HTTP网站,默认为主域名,如果目标网站的host有特殊要求,请自行修改;'."\n"
."\n"
.' **path**:HTTP路径,用户HTTP(S)健康检查的URL路径配置,系统默认填写“/”;'."\n"
."\n"
.' **code**:当执行HTTP(S)监控时,根据Web服务器的返回码判断Web服务器是否正常工作,大于返回码报警阈值时,系统认为应用服务出现异常:'."\n"
."\n"
.' - 400:Bad Request,即如果HTTP(S)请求携带了错误的请求参数,Web服务器将返回大于400的返回码,如果校验内容设置为“异常码大于400”,请务必在URL路径中填写精确的URL访问路径参数;'."\n"
."\n"
.' - 500:Server Error,即如果Web服务器出现了某些异常,将返回大于500的异常码,系统默认使用大于500的异常码作为报警阈值;'."\n"
."\n"
.' **sni**:是否开启sni,仅在HTTPS协议时使用。SNI(Server Name Indication)是TLS协议的一个扩展,它允许客户端在发起TLS握手时指定想要连接的主机名。由于TLS握手发生在HTTP请求的任何数据被发送之前,SNI允许服务器在发送证书之前知道客户端试图访问的服务,这使得服务器可以选择正确的证书来呈现给客户端。'."\n"
."\n"
.' - true-开启'."\n"
.' '."\n"
.' - false-未开启'."\n"
.' '."\n"
.' **followRedirect**:是否跟随3XX重定向'."\n"
."\n"
.' - true:监控点获取的状态码为3XX (301,302,303, 307,308) 时,跟随跳转;'."\n"
."\n"
.' - false:不跳转;'."\n"
."\n\n"
.'- **ping**:'."\n"
."\n"
.' **packetNum**:每次Ping监控,同时发出多少个ICMP数据包,可选20、50、100'."\n"
."\n"
.' **packetLossRate**:异常时丢包率,每次ping监控,对发出的ICMP数据包,计算丢包率(%)。丢包率=(丢失数据包/发送的总ICMP数据包数目)* 100%,达到丢包率阈值时,异常报警。丢包率可选值为:10、30、40、80、90、100',
'type' => 'string',
'example' => '{\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}',
],
'IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IspCityNode' => [
'title' => '探点信息',
'description' => '探测节点列表。',
'type' => 'array',
'items' => [
'description' => '探测节点信息。',
'type' => 'object',
'properties' => [
'CountryCode' => [
'title' => '国家 Code',
'description' => '国家编码。',
'type' => 'string',
'example' => '001',
],
'CountryName' => [
'title' => '国家名称',
'description' => '国家名称。',
'type' => 'string',
'example' => '中国',
],
'CityCode' => [
'title' => '城市 Code',
'description' => '城市编码。',
'type' => 'string',
'example' => '503',
],
'CityName' => [
'title' => '城市名称',
'description' => '城市名称。',
'type' => 'string',
'example' => '张家口市',
],
'GroupType' => [
'title' => '监控探点分组类型',
'description' => '探测节点分组类型:'."\n"
."\n"
.'- BGP:BGP节点。'."\n"
."\n"
.'- OVERSEAS:国际节点。'."\n"
."\n"
.'- ISP:运营商节点。',
'type' => 'string',
'example' => 'BGP',
],
'GroupName' => [
'title' => '监控探点分组类型名称',
'description' => '探测节点分组类型名称。',
'type' => 'string',
'example' => 'BGP',
],
'IspCode' => [
'title' => 'ISP Code',
'description' => '运营商编码。',
'type' => 'string',
'example' => '465',
],
'IspName' => [
'title' => 'ISP 名称',
'description' => '运营商名称。',
'type' => 'string',
'example' => '阿里巴巴',
],
],
],
],
],
],
'Remark' => [
'description' => '健康探测模板的备注。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Templates\\": {\\n \\"Template\\": [\\n {\\n \\"TemplateId\\": \\"mtp-89518052425100**80\\",\\n \\"CreateTime\\": \\"2024-03-23T13:09Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-29T13:20Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"Name\\": \\"IPv4-Ping\\",\\n \\"IpVersion\\": \\"IPv4\\",\\n \\"Protocol\\": \\"ping\\",\\n \\"Interval\\": 60,\\n \\"Timeout\\": 5000,\\n \\"EvaluationCount\\": 2,\\n \\"FailureRate\\": 50,\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\index.htm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aliyun.com\\\\\\\\\\\\\\"}\\",\\n \\"IspCityNodes\\": {\\n \\"IspCityNode\\": [\\n {\\n \\"CountryCode\\": \\"001\\",\\n \\"CountryName\\": \\"中国\\",\\n \\"CityCode\\": \\"503\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"GroupType\\": \\"BGP\\",\\n \\"GroupName\\": \\"BGP\\",\\n \\"IspCode\\": \\"465\\",\\n \\"IspName\\": \\"阿里巴巴\\"\\n }\\n ]\\n },\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '搜索健康检查模板列表',
'summary' => '查询健康检查模板列表信息。',
],
'CreateCloudGtmMonitorTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '模板名',
'description' => '健康检查探测模板的名称。为了方便区分和记忆,建议名称可以区分健康检查协议。',
'type' => 'string',
'required' => true,
'example' => 'Ping-IPv4',
],
],
[
'name' => 'IpVersion',
'in' => 'query',
'schema' => [
'title' => '探测的网络环境 IP 版本',
'description' => '探测节点IP地址的类型:'."\n"
."\n"
.'- IPv4:当探测的目标地址类型为IPv4地址时适用。'."\n"
."\n"
.'- IPv6:当探测的目标地址类型为IPv6地址时适用。',
'type' => 'string',
'required' => true,
'example' => 'IPv4',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'title' => '探测协议',
'description' => '对目标IP地址发起探测的协议类型:'."\n"
."\n"
.'- ping'."\n"
."\n"
.'- tcp'."\n"
."\n"
.'- http'."\n"
."\n"
.'- https',
'type' => 'string',
'required' => true,
'example' => 'ping',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'title' => '探测间隔(秒)',
'description' => '每次检查的时间间隔(秒),默认每间隔1分钟探测一次,健康检查间隔最小支持15秒(面向旗舰版实例开放)。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '60',
],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => [
'title' => '探测超时时间(毫秒)',
'description' => '探测超时时间(毫秒),大于超时时间未返回的数据包即判断为健康检查超时:'."\n"
."\n"
.'- 2000'."\n"
."\n"
.'- 3000'."\n"
."\n"
.'- 5000'."\n"
."\n"
.'- 10000',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '5000',
],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => [
'title' => '探测连续次数',
'description' => '重试次数,连续多次监控出现异常,系统才将应用服务判断为异常,以防止因为一些网络瞬间抖动等其他原因影响监控准确率。重试次数可选值为:'."\n"
."\n"
.'- 1'."\n"
."\n"
.'- 2'."\n"
."\n"
.'- 3',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '2',
],
],
[
'name' => 'FailureRate',
'in' => 'query',
'schema' => [
'title' => '告警失败率',
'description' => '所选节点探测失败比例(%),即健康检查异常的探测点占探测点总数的百分比,当失败比例超过设置的阈值时,将服务地址判断为异常。可设置的失败比例阈值为:'."\n"
."\n"
.'- 20'."\n"
."\n"
.'- 50'."\n"
."\n"
.'- 80'."\n"
."\n"
.'- 100',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '50',
],
],
[
'name' => 'ExtendInfo',
'in' => 'query',
'schema' => [
'description' => 'Json 字符串扩展信息,各协议检查所需参数:'."\n"
."\n"
.'- http(s):'."\n"
."\n"
.' **host**:执行HTTP(S)监控时,指定HTTP(S)请求头部信息中携带的Host字段,用于标识需要访问的具体HTTP网站,默认为主域名,如果目标网站的host有特殊要求,请自行修改;'."\n"
."\n"
.' **path**:HTTP路径,用户HTTP(S)健康检查的URL路径配置,系统默认填写“/”;'."\n"
."\n"
.' **code**:当执行HTTP(S)监控时,根据Web服务器的返回码判断Web服务器是否正常工作,大于返回码报警阈值时,系统认为应用服务出现异常:'."\n"
."\n"
.' - 400:Bad Request,即如果HTTP(S)请求携带了错误的请求参数,Web服务器将返回大于400的返回码,如果校验内容设置为“异常码大于400”,请务必在URL路径中填写精确的URL访问路径参数;'."\n"
."\n"
.' - 500:Server Error,即如果Web服务器出现了某些异常,将返回大于500的异常码,系统默认使用大于500的异常码作为报警阈值;'."\n"
."\n"
.' **sni**:是否开启sni,仅在HTTPS协议时使用。SNI(Server Name Indication)是TLS协议的一个扩展,它允许客户端在发起TLS握手时指定想要连接的主机名。由于TLS握手发生在HTTP请求的任何数据被发送之前,SNI允许服务器在发送证书之前知道客户端试图访问的服务,这使得服务器可以选择正确的证书来呈现给客户端。'."\n"
."\n"
.' - true-开启'."\n"
.' '."\n"
.' - false-未开启'."\n"
.' '."\n"
.' **followRedirect**:是否跟随3XX重定向'."\n"
."\n"
.' - true:监控点获取的状态码为3XX (301,302,303, 307,308) 时,跟随跳转;'."\n"
."\n"
.' - false:不跳转;'."\n"
."\n\n"
.'- ping:'."\n"
."\n"
.' **packetNum**:每次Ping监控,同时发出多少个ICMP数据包,可选20、50、100'."\n"
."\n"
.' **packetLossRate**:异常时丢包率,每次ping监控,对发出的ICMP数据包,计算丢包率(%)。丢包率=(丢失数据包/发送的总ICMP数据包数目)* 100%,达到丢包率阈值时,异常报警。丢包率可选值为:10、30、40、80、90、100',
'type' => 'string',
'required' => false,
'example' => '{\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}',
],
],
[
'name' => 'IspCityNodes',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '探测节点列表',
'description' => '探测节点列表,具体信息可通过调用 [ListCloudGtmMonitorNodes](~~2797349~~) 获取',
'type' => 'array',
'items' => [
'description' => '探测节点。',
'type' => 'object',
'properties' => [
'CityCode' => [
'title' => '探测节点 城市 code',
'description' => '探测节点-城市编码。',
'type' => 'string',
'required' => false,
'example' => '503',
],
'IspCode' => [
'title' => '探测节点 isp code',
'description' => '探测节点-运营商编码。',
'type' => 'string',
'required' => false,
'example' => '465',
],
],
'required' => false,
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
'TemplateId' => [
'description' => '健康探测模板ID,唯一标识健康探测模板。',
'type' => 'string',
'example' => 'mtp-89518052425100****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"Success\\": true,\\n \\"TemplateId\\": \\"mtp-89518052425100****\\"\\n}","type":"json"}]',
'title' => '创建健康探测模板',
'summary' => '根据传入参数创建健康探测模板。',
],
'DeleteCloudGtmMonitorTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '健康探测模板ID,唯一标识健康探测模板。',
'type' => 'string',
'required' => true,
'example' => 'mtp-89518052425100****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Success' => [
'description' => '删除健康探测模板操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '删除健康探测模板',
'summary' => '根据传入参数删除健康探测模板。',
],
'UpdateCloudGtmMonitorTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24****',
],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'title' => '模板 ID',
'description' => '需要修改的健康探测模板ID,唯一标识健康探测模板。',
'type' => 'string',
'required' => true,
'example' => 'mtp-89518052425100****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'title' => '模板名',
'description' => '健康检查探测模板的名称,一般为了方便配置人员区分和记忆,建议名称可以区分健康检查协议。',
'type' => 'string',
'required' => false,
'example' => 'Ping-IPv4'."\n",
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'title' => '探测间隔(秒)',
'description' => '每次健康探测的时间间隔(秒),默认每间隔1分钟探测一次,健康检查间隔最小支持15秒(面向旗舰版实例开放)。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => [
'title' => '探测超时时间',
'description' => '探测超时时间(毫秒),大于超时时间未返回的数据包即判断为健康检查超时:'."\n"
."\n"
.'- 2000'."\n"
."\n"
.'- 3000'."\n"
."\n"
.'- 5000'."\n"
."\n"
.'- 10000',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5000',
],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => [
'title' => '探测连续次数',
'description' => '重试次数,连续多次监控出现异常,系统才将应用服务判断为异常,以防止因为一些网络瞬间抖动等其他原因影响监控准确率。重试次数可选值为:'."\n"
."\n"
.'- 1'."\n"
."\n"
.'- 2'."\n"
."\n"
.'- 3',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'FailureRate',
'in' => 'query',
'schema' => [
'title' => '告警失败率',
'description' => '所选节点探测失败比例(%),即健康检查异常的探测点占探测点总数的百分比,当失败比例超过设置的阈值时,将服务地址判断为异常。可设置的失败比例阈值为:'."\n"
."\n"
.'- 20'."\n"
."\n"
.'- 50'."\n"
."\n"
.'- 80'."\n"
."\n"
.'- 100',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '50',
],
],
[
'name' => 'ExtendInfo',
'in' => 'query',
'schema' => [
'description' => 'Json 字符串扩展信息,各协议检查所需参数:'."\n"
."\n"
.'- http(s):'."\n"
."\n"
.' host:执行HTTP(S)监控时,指定HTTP(S)请求头部信息中携带的Host字段,用于标识需要访问的具体HTTP网站,默认为主域名,如果目标网站的host有特殊要求,请自行修改;'."\n"
."\n"
.' path:HTTP路径,用户HTTP(S)健康检查的URL路径配置,系统默认填写“/”;'."\n"
."\n"
.' code:当执行HTTP(S)监控时,根据Web服务器的返回码判断Web服务器是否正常工作,大于返回码报警阈值时,系统认为应用服务出现异常:'."\n"
."\n"
.' - 400:Bad Request,即如果HTTP(S)请求携带了错误的请求参数,Web服务器将返回大于400的返回码,如果校验内容设置为“异常码大于400”,请务必在URL路径中填写精确的URL访问路径参数;'."\n"
."\n"
.' - 500:Server Error,即如果Web服务器出现了某些异常,将返回大于500的异常码,系统默认使用大于500的异常码作为报警阈值;'."\n"
."\n"
.' sni:是否开启sni,仅在HTTPS协议时使用。SNI(Server Name Indication)是TLS协议的一个扩展,它允许客户端在发起TLS握手时指定想要连接的主机名。由于TLS握手发生在HTTP请求的任何数据被发送之前,SNI允许服务器在发送证书之前知道客户端试图访问的服务,这使得服务器可以选择正确的证书来呈现给客户端。'."\n"
."\n"
.' - true-开启'."\n"
.' '."\n"
.' - false-未开启'."\n"
.' '."\n"
.' followRedirect:是否跟随3XX重定向'."\n"
."\n"
.' - true:监控点获取的状态码为3XX (301,302,303, 307,308) 时,跟随跳转;'."\n"
."\n"
.' - false:不跳转;'."\n"
."\n"
.'- ping:'."\n"
."\n"
.' packetNum:每次Ping监控,同时发出多少个ICMP数据包,可选20、50、100'."\n"
."\n"
.' packetLossRate:异常时丢包率,每次ping监控,对发出的ICMP数据包,计算丢包率(%)。丢包率=(丢失数据包/发送的总ICMP数据包数目)* 100%,达到丢包率阈值时,异常报警。丢包率可选值为:10、30、40、80、90、100',
'type' => 'string',
'required' => false,
'example' => '{\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}',
],
],
[
'name' => 'IspCityNodes',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '探测节点列表',
'description' => '探测节点列表,具体信息可通过调用 [ListCloudGtmMonitorNodes](~~2797327~~)获取。',
'type' => 'array',
'items' => [
'description' => '探测节点。',
'type' => 'object',
'properties' => [
'CityCode' => [
'title' => '探测节点 城市 code',
'description' => '探测节点-城市编码。',
'type' => 'string',
'required' => false,
'example' => '503',
],
'IspCode' => [
'title' => '探测节点 isp code',
'description' => '探测节点-运营商编码。',
'type' => 'string',
'required' => false,
'example' => '465',
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'Success' => [
'description' => '修改健康探测模板操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改健康探测模板',
'summary' => '根据传入参数修改探测模板信息。',
],
'ListCloudGtmMonitorTemplates' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- zh-CN:中文。'."\n"
."\n"
.'- en-US(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '健康检查探测模板的名称,一般为了方便配置人员区分和记忆,建议名称可以区分健康检查协议。',
'type' => 'string',
'required' => false,
'example' => 'IPv4-Ping',
],
],
[
'name' => 'IpVersion',
'in' => 'query',
'schema' => [
'description' => '探测节点IP地址的类型:'."\n"
."\n"
.'- IPv4:当探测的目标地址类型为IPv4地址时适用。'."\n"
."\n"
.'- IPv6:当探测的目标地址类型为IPv6地址时适用。',
'type' => 'string',
'required' => false,
'example' => 'IPv4',
],
],
[
'name' => 'Protocol',
'in' => 'query',
'schema' => [
'description' => '对目标IP地址发起探测的协议类型:'."\n"
."\n"
.'- ping'."\n"
."\n"
.'- tcp'."\n"
."\n"
.'- http'."\n"
."\n"
.'- https',
'type' => 'string',
'required' => false,
'example' => 'ping',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '75446CC1-FC9A-4595-8D96-089D73D7A63D',
],
'TotalPages' => [
'description' => '数据分页后总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalItems' => [
'description' => '获取的健康探测模板列表总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '30',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Templates' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Template' => [
'description' => '健康探测模板列表。',
'type' => 'array',
'items' => [
'description' => '健康探测模板详细信息。',
'type' => 'object',
'properties' => [
'TemplateId' => [
'title' => '模板 ID ,全局唯一',
'description' => '健康探测模板ID,唯一标识健康探测模板。',
'type' => 'string',
'example' => 'mtp-89518052425100****',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '健康探测模板创建时间。',
'type' => 'string',
'example' => '2024-03-23T13:09Z',
],
'CreateTimestamp' => [
'description' => '健康探测模板创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '健康探测模板最后一次修改时间。',
'type' => 'string',
'example' => '2024-03-29T13:20Z',
],
'UpdateTimestamp' => [
'description' => '健康检查模板配置修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'Name' => [
'title' => '探测模板名称',
'description' => '健康检查探测模板的名称,一般为了方便配置人员区分和记忆。',
'type' => 'string',
'example' => 'IPv4-Ping',
],
'IpVersion' => [
'title' => '探测的网络环境 IP 版本',
'description' => '探测节点IP地址的类型:'."\n"
."\n"
.'- IPv4:当探测的目标地址类型为IPv4地址时适用。'."\n"
."\n"
.'- IPv6:当探测的目标地址类型为IPv6地址时适用。',
'type' => 'string',
'example' => 'IPv4',
],
'Protocol' => [
'title' => '探测协议',
'description' => '对目标IP地址发起探测的协议类型:'."\n"
."\n"
.'- ping'."\n"
."\n"
.'- tcp'."\n"
."\n"
.'- http'."\n"
."\n"
.'- https',
'type' => 'string',
'example' => 'ping',
],
'Interval' => [
'title' => '探测间隔(秒)',
'description' => '每次检查的时间间隔(秒),默认每间隔1分钟探测一次,健康检查间隔最小支持15秒(面向旗舰版实例开放)。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Timeout' => [
'title' => '探测超时时间',
'description' => '探测超时时间(毫秒),大于超时时间未返回的数据包即判断为健康检查超时:'."\n"
."\n"
.'- 2000'."\n"
."\n"
.'- 3000'."\n"
."\n"
.'- 5000'."\n"
."\n"
.'- 10000',
'type' => 'integer',
'format' => 'int32',
'example' => '5000',
],
'EvaluationCount' => [
'title' => '探测连续次数',
'description' => '重试次数,连续多次监控出现异常,系统才将应用服务判断为异常,以防止因为一些网络瞬间抖动等其他原因影响监控准确率。重试次数可选值为:'."\n"
."\n"
.'- 1'."\n"
."\n"
.'- 2'."\n"
."\n"
.'- 3',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'FailureRate' => [
'title' => '告警失败率',
'description' => '所选节点探测失败比例(%),即健康检查异常的探测点占探测点总数的百分比,当失败比例超过设置的阈值时,将服务地址判断为异常。可设置的失败比例阈值为:'."\n"
."\n"
.'- 20'."\n"
."\n"
.'- 50'."\n"
."\n"
.'- 80'."\n"
."\n"
.'- 100',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'ExtendInfo' => [
'description' => 'Json 字符串扩展信息,各协议检查所需参数:'."\n"
."\n"
.'- http(s):'."\n"
."\n"
.' **host**:执行HTTP(S)监控时,指定HTTP(S)请求头部信息中携带的Host字段,用于标识需要访问的具体HTTP网站,默认为主域名,如果目标网站的host有特殊要求,请自行修改;'."\n"
."\n"
.' **path**:HTTP路径,用户HTTP(S)健康检查的URL路径配置,系统默认填写“/”;'."\n"
."\n"
.' **code**:当执行HTTP(S)监控时,根据Web服务器的返回码判断Web服务器是否正常工作,大于返回码报警阈值时,系统认为应用服务出现异常:'."\n"
."\n"
.' - 400:Bad Request,即如果HTTP(S)请求携带了错误的请求参数,Web服务器将返回大于400的返回码,如果校验内容设置为“异常码大于400”,请务必在URL路径中填写精确的URL访问路径参数;'."\n"
."\n"
.' - 500:Server Error,即如果Web服务器出现了某些异常,将返回大于500的异常码,系统默认使用大于500的异常码作为报警阈值;'."\n"
."\n"
.' **sni**:是否开启sni,仅在HTTPS协议时使用。SNI(Server Name Indication)是TLS协议的一个扩展,它允许客户端在发起TLS握手时指定想要连接的主机名。由于TLS握手发生在HTTP请求的任何数据被发送之前,SNI允许服务器在发送证书之前知道客户端试图访问的服务,这使得服务器可以选择正确的证书来呈现给客户端。'."\n"
."\n"
.' - true-开启'."\n"
.' '."\n"
.' - false-未开启'."\n"
.' '."\n"
.' **followRedirect**:是否跟随3XX重定向'."\n"
."\n"
.' - true:监控点获取的状态码为3XX (301,302,303, 307,308) 时,跟随跳转;'."\n"
."\n"
.' - false:不跳转;'."\n"
."\n\n"
.'- ping:'."\n"
."\n"
.' **packetNum**:每次Ping监控,同时发出多少个ICMP数据包,可选20、50、100'."\n"
."\n"
.' **packetLossRate**:异常时丢包率,每次ping监控,对发出的ICMP数据包,计算丢包率(%)。丢包率=(丢失数据包/发送的总ICMP数据包数目)* 100%,达到丢包率阈值时,异常报警。丢包率可选值为:10、30、40、80、90、100',
'type' => 'string',
'example' => '{\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}'."\n",
],
'IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IspCityNode' => [
'title' => '探点信息',
'description' => '探测节点列表,具体信息可通过调用[ListCloudGtmMonitorNodes](~~2797327~~) 获取。',
'type' => 'array',
'items' => [
'description' => '探测节点。',
'type' => 'object',
'properties' => [
'CountryCode' => [
'title' => '国家 Code',
'description' => '国家编码。',
'type' => 'string',
'example' => '001',
],
'CountryName' => [
'title' => '国家名称',
'description' => '国家名称。',
'type' => 'string',
'example' => '中国',
],
'CityCode' => [
'title' => '城市 Code',
'description' => '城市编码。',
'type' => 'string',
'example' => '503',
],
'CityName' => [
'title' => '城市名称',
'description' => '城市名称。',
'type' => 'string',
'example' => '张家口市',
],
'GroupType' => [
'title' => '监控探点分组类型',
'description' => '探测节点分组类型:'."\n"
."\n"
.'- BGP:BGP节点'."\n"
."\n"
.'- OVERSEAS:国际节点'."\n"
."\n"
.'- ISP:运营商节点',
'type' => 'string',
'example' => 'BGP',
],
'GroupName' => [
'title' => '监控探点分组类型名称',
'description' => '探测节点分组名称。',
'type' => 'string',
'example' => 'BGP节点',
],
'IspCode' => [
'title' => 'ISP Code',
'description' => '运营商编码。',
'type' => 'string',
'example' => '465',
],
'IspName' => [
'title' => 'ISP 名称',
'description' => '运营商名称。',
'type' => 'string',
'example' => '阿里巴巴',
],
],
],
],
],
],
'Remark' => [
'description' => '健康探测模板的备注。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75446CC1-FC9A-4595-8D96-089D73D7A63D\\",\\n \\"TotalPages\\": 2,\\n \\"TotalItems\\": 30,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Templates\\": {\\n \\"Template\\": [\\n {\\n \\"TemplateId\\": \\"mtp-89518052425100****\\",\\n \\"CreateTime\\": \\"2024-03-23T13:09Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-29T13:20Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"Name\\": \\"IPv4-Ping\\",\\n \\"IpVersion\\": \\"IPv4\\",\\n \\"Protocol\\": \\"ping\\",\\n \\"Interval\\": 60,\\n \\"Timeout\\": 5000,\\n \\"EvaluationCount\\": 2,\\n \\"FailureRate\\": 50,\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\index.htm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aliyun.com\\\\\\\\\\\\\\"}\\\\n\\",\\n \\"IspCityNodes\\": {\\n \\"IspCityNode\\": [\\n {\\n \\"CountryCode\\": \\"001\\",\\n \\"CountryName\\": \\"中国\\",\\n \\"CityCode\\": \\"503\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"GroupType\\": \\"BGP\\",\\n \\"GroupName\\": \\"BGP节点\\",\\n \\"IspCode\\": \\"465\\",\\n \\"IspName\\": \\"阿里巴巴\\"\\n }\\n ]\\n },\\n \\"Remark\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取健康探测模板列表',
'summary' => '根据传入参数获取健康探测模板列表。',
],
'DescribeCloudGtmMonitorTemplate' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '设置返回后可用区名称的语言,取值:'."\n"
.'* **zh-CN**:中文。'."\n"
.'* **en-US**(默认值):英文。',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'description' => '要查询的健康探测模板ID,唯一标识健康探测模板。',
'type' => 'string',
'required' => true,
'example' => 'mtp-89518052425100****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF',
],
'TemplateId' => [
'title' => '模板 ID ,全局唯一',
'description' => '健康探测模板ID,唯一标识健康探测模板。',
'type' => 'string',
'example' => 'mtp-89518052425100****',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '健康探测模板创建时间。',
'type' => 'string',
'example' => '2024-03-23T13:09Z',
],
'CreateTimestamp' => [
'description' => '健康探测模板创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '健康检查模板配置修改时间。',
'type' => 'string',
'example' => '2024-03-29T13:20Z',
],
'UpdateTimestamp' => [
'description' => '健康检查模板配置修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'Name' => [
'title' => '探测模板名称',
'description' => '健康检查探测模板的名称,一般为了方便配置人员区分和记忆,建议名称可以区分健康检查协议。',
'type' => 'string',
'example' => 'Ping-IPv4',
],
'IpVersion' => [
'title' => '探测的网络环境 IP 版本',
'description' => '探测节点IP地址的类型:'."\n"
."\n"
.'- IPv4:当探测的目标地址类型为IPv4地址时适用;'."\n"
."\n"
.'- IPv6:当探测的目标地址类型为IPv6地址时适用;',
'type' => 'string',
'example' => 'IPv4',
],
'Protocol' => [
'title' => '探测协议',
'description' => '对目标IP地址发起探测的协议类型:'."\n"
."\n"
.'- ping'."\n"
."\n"
.'- tcp'."\n"
."\n"
.'- http'."\n"
."\n"
.'- https',
'type' => 'string',
'example' => 'ping',
],
'Interval' => [
'title' => '探测间隔(秒)',
'description' => '每次检查的时间间隔(秒),默认每间隔1分钟探测一次,健康检查间隔最小支持15秒(面向旗舰版实例开放)。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Timeout' => [
'title' => '探测超时时间',
'description' => '探测超时时间(毫秒),大于超时时间未返回的数据包即判断为健康检查超时:'."\n"
."\n"
.'- 2000'."\n"
."\n"
.'- 3000'."\n"
."\n"
.'- 5000'."\n"
."\n"
.'- 10000',
'type' => 'integer',
'format' => 'int32',
'example' => '5000',
],
'EvaluationCount' => [
'title' => '探测连续次数',
'description' => '重试次数,连续多次监控出现异常,系统才将应用服务判断为异常,以防止因为一些网络瞬间抖动等其他原因影响监控准确率。重试次数可选值为:'."\n"
."\n"
.'- 1'."\n"
."\n"
.'- 2'."\n"
."\n"
.'- 3',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'FailureRate' => [
'title' => '告警失败率',
'description' => '所选节点探测失败比例(%),即健康检查异常的探测点占探测点总数的百分比,当失败比例超过设置的阈值时,将服务地址判断为异常。可设置的失败比例阈值为:'."\n"
."\n"
.'- 20'."\n"
."\n"
.'- 50'."\n"
."\n"
.'- 80'."\n"
."\n"
.'- 100',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'ExtendInfo' => [
'description' => 'Json 字符串扩展信息,各协议检查所需参数:'."\n"
."\n"
.'- http(s):'."\n"
."\n"
.' **host**:执行HTTP(S)监控时,指定HTTP(S)请求头部信息中携带的Host字段,用于标识需要访问的具体HTTP网站,默认为主域名,如果目标网站的host有特殊要求,请自行修改;'."\n"
."\n"
.' **path**:HTTP路径,用户HTTP(S)健康检查的URL路径配置,系统默认填写“/”;'."\n"
."\n"
.' **code**:当执行HTTP(S)监控时,根据Web服务器的返回码判断Web服务器是否正常工作,大于返回码报警阈值时,系统认为应用服务出现异常:'."\n"
."\n"
.' - 400:Bad Request,即如果HTTP(S)请求携带了错误的请求参数,Web服务器将返回大于400的返回码,如果校验内容设置为“异常码大于400”,请务必在URL路径中填写精确的URL访问路径参数;'."\n"
."\n"
.' - 500:Server Error,即如果Web服务器出现了某些异常,将返回大于500的异常码,系统默认使用大于500的异常码作为报警阈值;'."\n"
."\n"
.' **sni**:是否开启sni,仅在HTTPS协议时使用。SNI(Server Name Indication)是TLS协议的一个扩展,它允许客户端在发起TLS握手时指定想要连接的主机名。由于TLS握手发生在HTTP请求的任何数据被发送之前,SNI允许服务器在发送证书之前知道客户端试图访问的服务,这使得服务器可以选择正确的证书来呈现给客户端。'."\n"
."\n"
.' - true-开启'."\n"
.' '."\n"
.' - false-未开启'."\n"
.' '."\n"
.' **followRedirect**:是否跟随3XX重定向'."\n"
."\n"
.' - true:监控点获取的状态码为3XX (301,302,303, 307,308) 时,跟随跳转;'."\n"
."\n"
.' - false:不跳转;'."\n"
."\n\n"
.'- ping:'."\n"
."\n"
.' **packetNum**:每次Ping监控,同时发出多少个ICMP数据包,可选20、50、100'."\n"
."\n"
.' **packetLossRate**:异常时丢包率,每次ping监控,对发出的ICMP数据包,计算丢包率(%)。丢包率=(丢失数据包/发送的总ICMP数据包数目)* 100%,达到丢包率阈值时,异常报警。丢包率可选值为:10、30、40、80、90、100',
'type' => 'string',
'example' => '{\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}',
],
'IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IspCityNode' => [
'title' => '探点信息',
'description' => '探测节点列表,具体信息可通过调用 ListCloudGtmMonitorNodes 获取。',
'type' => 'array',
'items' => [
'description' => '探测节点',
'type' => 'object',
'properties' => [
'CountryCode' => [
'title' => '国家 Code',
'description' => '国家编码',
'type' => 'string',
'example' => '001',
],
'CountryName' => [
'title' => '国家名称',
'description' => '国家名称',
'type' => 'string',
'example' => '中国',
],
'CityCode' => [
'title' => '城市 Code',
'description' => '城市编码',
'type' => 'string',
'example' => '503',
],
'CityName' => [
'title' => '城市名称',
'description' => '城市名称',
'type' => 'string',
'example' => '张家口市',
],
'GroupType' => [
'title' => '监控探点分组类型',
'description' => '探测节点分组类型:'."\n"
."\n"
.'- BGP:BGP节点'."\n"
."\n"
.'- OVERSEAS:国际节点'."\n"
."\n"
.'- ISP:运营商节点',
'type' => 'string',
'example' => 'BGP',
],
'GroupName' => [
'title' => '监控探点分组类型名称',
'description' => '探测节点分组类型名称',
'type' => 'string',
'example' => 'BGP节点',
],
'IspCode' => [
'title' => 'ISP Code',
'description' => '运营商编码',
'type' => 'string',
'example' => '465',
],
'IspName' => [
'title' => 'ISP 名称',
'description' => '运营商名称',
'type' => 'string',
'example' => '阿里巴巴',
],
],
],
],
],
],
'Remark' => [
'description' => '健康探测模板的备注。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF\\",\\n \\"TemplateId\\": \\"mtp-89518052425100****\\",\\n \\"CreateTime\\": \\"2024-03-23T13:09Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-29T13:20Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"Name\\": \\"Ping-IPv4\\",\\n \\"IpVersion\\": \\"IPv4\\",\\n \\"Protocol\\": \\"ping\\",\\n \\"Interval\\": 60,\\n \\"Timeout\\": 5000,\\n \\"EvaluationCount\\": 2,\\n \\"FailureRate\\": 50,\\n \\"ExtendInfo\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\index.htm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aliyun.com\\\\\\\\\\\\\\"}\\",\\n \\"IspCityNodes\\": {\\n \\"IspCityNode\\": [\\n {\\n \\"CountryCode\\": \\"001\\",\\n \\"CountryName\\": \\"中国\\",\\n \\"CityCode\\": \\"503\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"GroupType\\": \\"BGP\\",\\n \\"GroupName\\": \\"BGP节点\\",\\n \\"IspCode\\": \\"465\\",\\n \\"IspName\\": \\"阿里巴巴\\"\\n }\\n ]\\n },\\n \\"Remark\\": \\"test\\"\\n}","type":"json"}]',
'title' => '获取指定健康探测模板配置',
'summary' => '根据传入参数获取指定健康探测模板配置。',
],
'UpdateCloudGtmMonitorTemplateRemark' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US:英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24**22',
],
],
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => [
'title' => '地址 ID',
'description' => '健康探测模板ID,唯一标识健康探测模板。',
'type' => 'string',
'required' => true,
'example' => 'mtp-89518052455928**00',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'title' => '备注',
'description' => '填写更新后的备注,传空值则删除备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'Success' => [
'description' => '修改健康探测模板备注操作是否成功:'."\n"
."\n"
.'- true:操作成功'."\n"
."\n"
.'- false:操作失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改健康探测模板备注',
],
'ListCloudGtmMonitorNodes' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- **zh-CN**:中文'."\n"
."\n"
.'- **en-US**(默认值):英文',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Ipv4IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ipv4IspCityNode' => [
'description' => '公网IPv4监控节点列表。',
'type' => 'array',
'items' => [
'description' => '公网IPv4监控节点信息。',
'type' => 'object',
'properties' => [
'CountryCode' => [
'title' => '国家 Code',
'description' => '国家编码。',
'type' => 'string',
'example' => '001',
],
'CountryName' => [
'title' => '国家名称',
'description' => '国家名称。',
'type' => 'string',
'example' => '中国',
],
'CityCode' => [
'title' => '城市 Code',
'description' => '城市编码。',
'type' => 'string',
'example' => '503',
],
'CityName' => [
'title' => '城市名称',
'description' => '城市名称。',
'type' => 'string',
'example' => '张家口市',
],
'GroupType' => [
'title' => '监控探点分组类型',
'description' => '监控节点分组类型,当前支持:'."\n"
."\n"
.'- BGP:BGP节点'."\n"
."\n"
.'- OVERSEAS:国际节点'."\n"
."\n"
.'- ISP:运营商节点',
'type' => 'string',
'example' => 'BGP',
],
'GroupName' => [
'title' => '监控探点分组类型名称',
'description' => '监控探点分组名称。',
'type' => 'string',
'example' => 'BGP节点',
],
'IspCode' => [
'title' => 'ISP Code',
'description' => '运营商编码。',
'type' => 'string',
'example' => '465',
],
'IspName' => [
'title' => 'ISP 名称',
'description' => '运营商名称。',
'type' => 'string',
'example' => '阿里巴巴',
],
'DefaultSelected' => [
'title' => '是否默认勾选',
'description' => '监控节点是否默认选中:'."\n"
."\n"
.'- true:默认选中'."\n"
."\n"
.'- false:默认不选中',
'type' => 'boolean',
'example' => 'true',
],
'NodeId' => [
'description' => '探测节点的唯一标识 ID。',
'type' => 'string',
'example' => 'node-ewze1bysndy4gf**j8',
],
'Ips' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ip' => [
'description' => '节点IP列表。',
'type' => 'array',
'items' => [
'description' => '节点IP列表。',
'type' => 'string',
'example' => ' ['."\n"
.' "47.92.XX.XX",'."\n"
.' "47.92.XX.XX",'."\n"
.' "39.98.XX.XX",'."\n"
.' "39.100.XX.XX"'."\n"
.' ]',
],
],
],
],
],
],
],
],
],
'Ipv6IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ipv6IspCityNode' => [
'description' => '公网IPv6监控节点列表。',
'type' => 'array',
'items' => [
'description' => '公网Ipv6监控节点。'."\n"
."\n",
'type' => 'object',
'properties' => [
'CountryCode' => [
'title' => '国家 Code',
'description' => '国家编码。',
'type' => 'string',
'example' => '001',
],
'CountryName' => [
'title' => '国家名称',
'description' => '国家名称。',
'type' => 'string',
'example' => '中国',
],
'CityCode' => [
'title' => '城市 Code',
'description' => '城市编码。',
'type' => 'string',
'example' => '503',
],
'CityName' => [
'title' => '城市名称',
'description' => '城市名称。',
'type' => 'string',
'example' => '张家口市',
],
'GroupType' => [
'title' => '监控探点分组类型',
'description' => '监控节点分组类型,当前支持:'."\n"
."\n"
.'- BGP:BGP节点'."\n"
."\n"
.'- OVERSEAS:国际节点'."\n"
."\n"
.'- ISP:运营商节点',
'type' => 'string',
'example' => 'BGP',
],
'GroupName' => [
'title' => '监控探点分组类型名称',
'description' => '监控探点分组名称。',
'type' => 'string',
'example' => 'BGP节点',
],
'IspCode' => [
'title' => 'ISP Code',
'description' => '运营商编码。',
'type' => 'string',
'example' => '465',
],
'IspName' => [
'title' => 'ISP 名称',
'description' => '运营商名称。',
'type' => 'string',
'example' => '阿里巴巴',
],
'DefaultSelected' => [
'title' => '是否默认勾选',
'description' => '监控节点是否默认选中:'."\n"
."\n"
.'- true:默认选中'."\n"
."\n"
.'- false:默认不选中',
'type' => 'boolean',
'example' => 'true',
],
'NodeId' => [
'description' => '探测节点的唯一标识 ID。',
'type' => 'string',
'example' => 'node-ewze1bysndy4gf**j8'."\n",
],
'Ips' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ip' => [
'description' => '节点IP列表。',
'type' => 'array',
'items' => [
'description' => '节点IP列表。',
'type' => 'string',
'example' => ' ['."\n"
.' "240e:e9:6002:15c:0:ff:b015:1**f",'."\n"
.' "240e:e9:6002:15a:0:ff:b05c:1**8"'."\n"
.' ]'."\n",
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Ipv4IspCityNodes\\": {\\n \\"Ipv4IspCityNode\\": [\\n {\\n \\"CountryCode\\": \\"001\\",\\n \\"CountryName\\": \\"中国\\",\\n \\"CityCode\\": \\"503\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"GroupType\\": \\"BGP\\",\\n \\"GroupName\\": \\"BGP节点\\",\\n \\"IspCode\\": \\"465\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"DefaultSelected\\": true,\\n \\"NodeId\\": \\"node-ewze1bysndy4gf**j8\\",\\n \\"Ips\\": {\\n \\"Ip\\": [\\n \\" [\\\\n \\\\\\"47.92.XX.XX\\\\\\",\\\\n \\\\\\"47.92.XX.XX\\\\\\",\\\\n \\\\\\"39.98.XX.XX\\\\\\",\\\\n \\\\\\"39.100.XX.XX\\\\\\"\\\\n ]\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"Ipv6IspCityNodes\\": {\\n \\"Ipv6IspCityNode\\": [\\n {\\n \\"CountryCode\\": \\"001\\",\\n \\"CountryName\\": \\"中国\\",\\n \\"CityCode\\": \\"503\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"GroupType\\": \\"BGP\\",\\n \\"GroupName\\": \\"BGP节点\\",\\n \\"IspCode\\": \\"465\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"DefaultSelected\\": true,\\n \\"NodeId\\": \\"node-ewze1bysndy4gf**j8\\\\n\\",\\n \\"Ips\\": {\\n \\"Ip\\": [\\n \\" [\\\\n \\\\\\"240e:e9:6002:15c:0:ff:b015:1**f\\\\\\",\\\\n \\\\\\"240e:e9:6002:15a:0:ff:b05c:1**8\\\\\\"\\\\n ]\\\\n\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取健康检查探点列表',
'summary' => '根据传入参数获取健康探测检查探点列表。',
],
'DescribeCloudGtmSystemLines' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SystemLines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SystemLine' => [
'description' => '系统线路列表。',
'type' => 'array',
'items' => [
'description' => '系统线路信息。',
'type' => 'object',
'properties' => [
'Code' => [
'description' => '线路code。',
'type' => 'string',
'example' => 'aliyun_r_ap-south-1',
],
'ParentCode' => [
'description' => '线路父级code。',
'type' => 'string',
'example' => 'String aliyun',
],
'IsAvailable' => [
'description' => '线路是否可以作为解析请求来源被选中:'."\n"
."\n"
.'- true:可被选中;'."\n"
."\n"
.'- false:不可被选中;',
'type' => 'boolean',
'example' => 'true',
],
'DisplayName' => [
'description' => '线路展示名称。',
'type' => 'string',
'example' => '华北_河北',
],
'Name' => [
'description' => '线路名称。',
'type' => 'string',
'example' => '河北',
],
],
],
],
],
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA',
],
'SystemLinesTree' => [
'description' => '系统线路树状结构数据,线路很多,此处不一一列举。',
'type' => 'string',
'example' => '"SystemLinesTree":"[{\\"displayName\\":\\"默认\\",\\"id\\":\\"default\\",\\"isAvailable\\":true,\\"name\\":\\"默认\\",\\"parentId\\":\\"\\"}',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SystemLines\\": {\\n \\"SystemLine\\": [\\n {\\n \\"Code\\": \\"aliyun_r_ap-south-1\\",\\n \\"ParentCode\\": \\"String\\\\taliyun\\",\\n \\"IsAvailable\\": true,\\n \\"DisplayName\\": \\"华北_河北\\",\\n \\"Name\\": \\"河北\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA\\",\\n \\"SystemLinesTree\\": \\"\\\\\\"SystemLinesTree\\\\\\":\\\\\\"[{\\\\\\\\\\\\\\"displayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"默认\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"isAvailable\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"默认\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parentId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}\\"\\n}","type":"json"}]',
'title' => '查询GTM支持的系统线路',
'summary' => '查询GTM支持的系统线路',
],
'ListCloudGtmAlertLogs' => [
'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-CN:中文'."\n"
."\n"
.'- en-US:英文',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'ActionType',
'in' => 'query',
'schema' => [
'title' => '地址名称',
'description' => '告警类型:'."\n"
."\n"
.'- ALERT:告警'."\n"
."\n"
.'- RESUME:恢复',
'type' => 'string',
'required' => false,
'example' => 'ALERT',
],
],
[
'name' => 'EntityType',
'in' => 'query',
'schema' => [
'title' => '地址类型',
'description' => '告警对象:'."\n"
."\n"
.'- GTM_ADDRESS:地址'."\n"
."\n"
.'- GTM_ADDRESS_POOL:地址池'."\n"
."\n"
.'- GTM_INSTANCE:实例'."\n"
."\n"
.'- GTM_MONITOR_TEMPLATE:健康探测模板',
'type' => 'string',
'required' => false,
'example' => 'GTM_ADDRESS',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'title' => '地址',
'description' => '搜索关键词,一般为地址 ID、地址池 ID、域名信息等。',
'type' => 'string',
'required' => false,
'example' => 'pool-895280232254422016',
],
],
[
'name' => 'StartTimestamp',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1611328826977',
],
],
[
'name' => 'EndTimestamp',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1711328826977',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '告警日志总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'Logs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Log' => [
'description' => '告警日志列表。',
'type' => 'array',
'items' => [
'description' => '告警日志信息。',
'type' => 'object',
'properties' => [
'ActionType' => [
'title' => '地址 ID',
'description' => '告警类型:'."\n"
."\n"
.'- ALERT:告警'."\n"
."\n"
.'- RESUME:恢复',
'type' => 'string',
'example' => 'ALERT',
],
'EntityType' => [
'title' => '创建时间',
'description' => '告警对象:'."\n"
."\n"
.'- GTM_ADDRESS:地址'."\n"
."\n"
.'- GTM_ADDRESS_POOL:地址池'."\n"
."\n"
.'- GTM_INSTANCE:实例'."\n"
."\n"
.'- GTM_MONITOR_TEMPLATE:健康探测模板',
'type' => 'string',
'example' => 'GTM_ADDRESS',
],
'Content' => [
'title' => '修改时间',
'description' => '告警内容。',
'type' => 'string',
'example' => '"Pool name:华东\\nType:IPv4\\nReason: Normal health determination\\nNumber of addresses in the pool : 2\\nAbnormal address: --\\nDetermination conditions : Any address in the addresspool is available address\\nAffected domain names: www.cloud-example.com"',
],
'Timestamp' => [
'description' => '告警日志时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1711328826977',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 15,\\n \\"Logs\\": {\\n \\"Log\\": [\\n {\\n \\"ActionType\\": \\"ALERT\\",\\n \\"EntityType\\": \\"GTM_ADDRESS\\",\\n \\"Content\\": \\"\\\\\\"Pool name:华东\\\\\\\\nType:IPv4\\\\\\\\nReason: Normal health determination\\\\\\\\nNumber of addresses in the pool : 2\\\\\\\\nAbnormal address: --\\\\\\\\nDetermination conditions : Any address in the addresspool is available address\\\\\\\\nAffected domain names: www.cloud-example.com\\\\\\"\\",\\n \\"Timestamp\\": 1711328826977\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取告警日志列表',
'summary' => '获取告警日志列表',
],
'DescribeCloudGtmInstanceConfigAlert' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值: '."\n"
.' '."\n"
.'- **zh-CN**:中文。'."\n"
."\n"
.'- **en-US**:英文。',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24**22',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '全局流量管理3.0实例id。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '域名实例配置id,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。',
'type' => 'string',
'required' => false,
'example' => 'Config-000**11',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0F32959D-417B-4D66-8463-68606605E3E2',
],
'InstanceId' => [
'title' => '实例id',
'description' => '全局流量管理3.0实例id。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**',
],
'ConfigId' => [
'title' => '实例id',
'description' => '域名实例配置id,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。',
'type' => 'string',
'example' => 'Config-000**11'."\n",
],
'AlertMode' => [
'title' => '备注',
'description' => '实例告警配置模式:'."\n"
."\n"
.'- global:继承全局报警配置,即实例采用全局告警配置'."\n"
."\n"
.'- instance_config:自定义报警配置',
'type' => 'string',
'example' => 'global',
],
'AlertGroup' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AlertGroup' => [
'description' => '告警通知组列表。',
'type' => 'array',
'items' => [
'description' => '告警通知组。',
'type' => 'string',
'example' => '[\\"云账号报警联系人\\"]',
],
],
],
],
'AlertConfig' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AlertConfig' => [
'description' => '报警配置列表。',
'type' => 'array',
'items' => [
'description' => '报警规则配置信息。',
'type' => 'object',
'properties' => [
'NoticeType' => [
'description' => '报警事件类型:'."\n"
."\n"
.'- addr_alert:地址不可用'."\n"
."\n"
.'- addr_resume:地址恢复可用'."\n"
."\n"
.'- addr_pool_unavailable:地址池不可用'."\n"
."\n"
.'- addr_pool_available:地址池恢复可用',
'type' => 'string',
'example' => 'addr_alert',
],
'SmsNotice' => [
'description' => '是否配置短信报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送短信通知'."\n"
."\n"
.'- false:未配置'."\n"
."\n"
.'仅中国站支持短信通知,国际站不支持短信通知。',
'type' => 'boolean',
'example' => 'true',
],
'EmailNotice' => [
'description' => '是否配置邮件报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送邮件通知'."\n"
."\n"
.'- false:未配置',
'type' => 'boolean',
'example' => 'true',
],
'DingtalkNotice' => [
'description' => '是否配置钉钉报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送钉钉通知'."\n"
."\n"
.'- false:未配置',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0F32959D-417B-4D66-8463-68606605E3E2\\",\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3hbz**\\",\\n \\"ConfigId\\": \\"Config-000**11\\\\n\\",\\n \\"AlertMode\\": \\"global\\",\\n \\"AlertGroup\\": {\\n \\"AlertGroup\\": [\\n \\"[\\\\\\\\\\\\\\"云账号报警联系人\\\\\\\\\\\\\\"]\\"\\n ]\\n },\\n \\"AlertConfig\\": {\\n \\"AlertConfig\\": [\\n {\\n \\"NoticeType\\": \\"addr_alert\\",\\n \\"SmsNotice\\": true,\\n \\"EmailNotice\\": true,\\n \\"DingtalkNotice\\": true\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取实例配置的告警配置',
'summary' => '获取实例配置的告警配置',
],
'UpdateCloudGtmGlobalAlert' => [
'summary' => '更新全局流量管理告警设置',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns6GP3X5',
],
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回结果显示的语言。取值:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US:英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24**22'."\n",
],
],
[
'name' => 'AlertGroup',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '告警通知组列表。',
'type' => 'array',
'items' => [
'description' => '告警通知组信息,读取云监控产品下的告警通知组配置。',
'type' => 'string',
'required' => false,
'example' => '[\\"云账号报警联系人\\"]',
],
'required' => false,
],
],
[
'name' => 'AlertConfig',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '报警配置列表。',
'type' => 'array',
'items' => [
'description' => '报警配置。',
'type' => 'object',
'properties' => [
'NoticeType' => [
'description' => '报警事件类型:'."\n"
."\n"
.'- addr_alert:地址不可用'."\n"
."\n"
.'- addr_resume:地址恢复可用'."\n"
."\n"
.'- addr_pool_unavailable:地址池不可用'."\n"
."\n"
.'- addr_pool_available:地址池恢复可用',
'type' => 'string',
'required' => false,
'example' => 'addr_alert',
],
'SmsNotice' => [
'description' => '是否配置短信报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送短信通知'."\n"
.'- false|null:未配置'."\n"
."\n"
.'仅中国站支持短信通知,国际站不支持短信通知。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'EmailNotice' => [
'description' => '是否配置邮件报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送邮件通知'."\n"
."\n"
.'- false|null:未配置',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'DingtalkNotice' => [
'description' => '是否配置钉钉报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送钉钉通知'."\n"
.'- false:未配置',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'Threshold' => [
'title' => '阈值,仅突增突降类指标支持',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'default' => '50',
'example' => '100',
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'Success' => [
'description' => '本次修改全局告警配置操作是否成功:'."\n"
.'- true:成功'."\n"
.'- false:失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '修改全局告警配置',
],
'DescribeCloudGtmGlobalAlert' => [
'summary' => '查询全局流量管理告警配置',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns6GP3X5',
],
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回信息的语言类型:'."\n"
."\n"
.'- zh-CN:中文'."\n"
."\n"
.'- en-US:英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24**22',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => 'B57C121B-A45F-44D8-A9B2-13E5A5044195',
],
'AlertGroup' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AlertGroup' => [
'description' => '告警通知组列表。',
'type' => 'array',
'items' => [
'description' => '告警通知组。',
'type' => 'string',
'example' => '[\\"云账号报警联系人\\"]',
],
],
],
],
'AlertConfig' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AlertConfig' => [
'description' => '报警配置列表。',
'type' => 'array',
'items' => [
'description' => '报警规则配置信息。',
'type' => 'object',
'properties' => [
'NoticeType' => [
'description' => '报警事件类型:'."\n"
."\n"
.'- addr_alert:地址不可用'."\n"
."\n"
.'- addr_resume:地址恢复可用'."\n"
."\n"
.'- addr_pool_unavailable:地址池不可用'."\n"
."\n"
.'- addr_pool_available:地址池恢复可用',
'type' => 'string',
'example' => 'addr_alert',
],
'SmsNotice' => [
'description' => '是否配置短信报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送短信通知'."\n"
."\n"
.'- false:未配置'."\n"
."\n"
.'仅中国站支持短信通知,国际站不支持短信通知。',
'type' => 'boolean',
'example' => 'true',
],
'EmailNotice' => [
'description' => '是否配置邮件报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送邮件通知'."\n"
."\n"
.'- false:未配置',
'type' => 'boolean',
'example' => 'true',
],
'DingtalkNotice' => [
'description' => '是否配置钉钉报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送钉钉通知'."\n"
."\n"
.'- false:未配置',
'type' => 'boolean',
'example' => 'false',
],
'Threshold' => [
'title' => '阈值,仅突增突降类指标支持',
'description' => '阈值,仅突增突降类指标支持',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
'default' => '50',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B57C121B-A45F-44D8-A9B2-13E5A5044195\\",\\n \\"AlertGroup\\": {\\n \\"AlertGroup\\": [\\n \\"[\\\\\\\\\\\\\\"云账号报警联系人\\\\\\\\\\\\\\"]\\"\\n ]\\n },\\n \\"AlertConfig\\": {\\n \\"AlertConfig\\": [\\n {\\n \\"NoticeType\\": \\"addr_alert\\",\\n \\"SmsNotice\\": true,\\n \\"EmailNotice\\": true,\\n \\"DingtalkNotice\\": false,\\n \\"Threshold\\": 50\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取全局告警配置',
],
'UpdateCloudGtmInstanceConfigAlert' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回信息的语言类型:'."\n"
."\n"
.'- zh-CN:中文'."\n"
.'- en-US:英文',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。注意 由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24**22',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '全局流量管理3.0实例id。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-zz11t58**0s',
],
],
[
'name' => 'ConfigId',
'in' => 'query',
'schema' => [
'description' => '域名实例配置id,相同接入域名、相同的GTM实例可以同时配置A和AAAA记录,此情况下相同的GTM实例会出现2个域名实例配置,ConfigId可以唯一标识域名实例配置。',
'type' => 'string',
'required' => false,
'example' => 'Config-000**11',
],
],
[
'name' => 'AlertMode',
'in' => 'query',
'schema' => [
'description' => '实例告警配置模式:'."\n"
."\n"
.'- global:继承全局报警配置,即实例采用全局告警配置'."\n"
."\n"
.'- instance_config:自定义报警配置',
'type' => 'string',
'required' => false,
'example' => 'global',
],
],
[
'name' => 'AlertGroup',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '告警通知组列表。',
'type' => 'array',
'items' => [
'description' => '告警通知组信息。',
'type' => 'string',
'required' => false,
'example' => '[\\"云账号报警联系人\\"]',
],
'required' => false,
],
],
[
'name' => 'AlertConfig',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '报警配置列表。',
'type' => 'array',
'items' => [
'description' => '报警规则配置信息。',
'type' => 'object',
'properties' => [
'NoticeType' => [
'description' => '报警事件类型:'."\n"
."\n"
.'- addr_alert:地址不可用'."\n"
."\n"
.'- addr_resume:地址恢复可用'."\n"
."\n"
.'- addr_pool_unavailable:地址池不可用'."\n"
."\n"
.'- addr_pool_available:地址池恢复可用',
'type' => 'string',
'required' => false,
'example' => 'addr_alert',
],
'SmsNotice' => [
'description' => '是否配置短信报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送短信通知'."\n"
."\n"
.'- false:未配置'."\n"
."\n"
.'仅中国站支持短信通知,国际站不支持短信通知。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'EmailNotice' => [
'description' => '是否配置邮件报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送邮件通知'."\n"
."\n"
.'- false:未配置',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'DingtalkNotice' => [
'description' => '是否配置钉钉报警通知:'."\n"
."\n"
.'- true:已配置,当报警事情发生时,会发送钉钉通知'."\n"
."\n"
.'- false:未配置',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '更新实例的告警配置',
],
'ListCloudGtmAvailableAlertGroups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'- **zh-CN**:中文'."\n"
."\n"
.'- **en-US**:英文',
'type' => 'string',
'required' => false,
'example' => 'en-US',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'AlertGroups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AlertGroup' => [
'description' => '报警通知组列表。',
'type' => 'array',
'items' => [
'description' => '报警通知组。',
'type' => 'object',
'properties' => [
'GroupName' => [
'title' => '地址 ID',
'description' => '报警通知组名称。',
'type' => 'string',
'example' => '云账号报警联系人',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"AlertGroups\\": {\\n \\"AlertGroup\\": [\\n {\\n \\"GroupName\\": \\"云账号报警联系人\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '获取用户可用的告警组列表',
],
'SetGtmAccessMode' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StrategyId',
'in' => 'query',
'schema' => [
'description' => '访问策略ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hra0hx',
],
],
[
'name' => 'AccessMode',
'in' => 'query',
'schema' => [
'description' => '目标访问策略。取值:'."\n"
.'- **AUTO**: 自动切换'."\n"
.'- **DEFAULT**:主地址池集合'."\n"
.'- **FAILOVER**: 备地址池集合',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'AUTO',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\r\\n","errorExample":""}]',
'title' => '修改生效地址池切换策略(旧版)',
'summary' => '根据传入参数修改生效地址池切换策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDnsGtmInstanceGlobalConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => 'GTM实例ID。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '实例名称:首次更新必填,再次更新则非必填。',
'type' => 'string',
'required' => false,
'example' => 'test-1',
],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => [
'description' => '全局TTL。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '9999999',
'minimum' => '1',
'example' => '60',
],
],
[
'name' => 'PublicCnameMode',
'in' => 'query',
'schema' => [
'description' => '公网域名接入方式:'."\n"
."\n"
.'- SYSTEM_ASSIGN:系统分配(此选项功能关闭)'."\n"
.'- CUSTOM:自定义',
'type' => 'string',
'required' => false,
'example' => 'CUSTOM',
],
],
[
'name' => 'PublicUserDomainName',
'in' => 'query',
'schema' => [
'description' => '业务域名(公网)。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'PublicZoneName',
'in' => 'query',
'schema' => [
'description' => 'CNAME接入域名(公网):主域名,且当为自定义接入时为必填。'."\n"
."\n"
.'> 此处应填入主域名,不包含PublicRr参数内容'."\n",
'type' => 'string',
'required' => false,
'example' => 'www.example.com',
],
],
[
'name' => 'AlertGroup',
'in' => 'query',
'schema' => [
'description' => '报警组(List的JSON格式)。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => '["test1","test2"]',
],
],
[
'name' => 'CnameType',
'in' => 'query',
'schema' => [
'description' => 'CNAME接入域名类型:'."\n"
."\n"
.'- PUBLIC: 公网型',
'type' => 'string',
'required' => false,
'example' => 'PUBLIC',
],
],
[
'name' => 'AlertConfig',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '报警配置列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SmsNotice' => [
'description' => '是否配置短信通知:'."\n"
."\n"
.'- true:已配置'."\n"
.'- false|null : 未配置',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'NoticeType' => [
'description' => '报警事件类型:'."\n"
."\n"
.'- ADDR_ALERT:地址不可用'."\n"
.'- ADDR_RESUME:地址恢复可用'."\n"
.'- ADDR_POOL_GROUP_UNAVAILABLE:地址池集合不可用'."\n"
.'- ADDR_POOL_GROUP_AVAILABLE:地址池集合恢复可用'."\n"
.'- ACCESS_STRATEGY_POOL_GROUP_SWITCH:主备地址池切换'."\n"
.'- MONITOR_NODE_IP_CHANGE:监控节点IP地址变更',
'type' => 'string',
'required' => false,
'example' => 'ADDR_ALERT',
],
'EmailNotice' => [
'description' => '是否配置邮件通知:'."\n"
."\n"
.'- true:已配置'."\n"
.'- false|null : 未配置',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'DingtalkNotice' => [
'description' => '是否需要钉钉报警:'."\n"
."\n"
.'- true-需要'."\n"
.'- false-不需要',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'PublicRr',
'in' => 'query',
'schema' => [
'description' => 'CNAME接入域名(公网):主机名',
'type' => 'string',
'required' => false,
'example' => 'test.rr',
],
],
[
'name' => 'ForceUpdate',
'in' => 'query',
'schema' => [
'description' => '是否强制更新。'."\n"
."\n"
.'- true-强制更新,不进行冲突提示。'."\n"
.'- false|null-不强制更新,若遇冲突则提示。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF559**',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DnsGtmInstance.PublicRrDuplicate.OtherUserInstance',
'errorMessage' => ' ',
],
[
'errorCode' => 'GtmInstance.CnameModeDeny',
'errorMessage' => ' ',
],
[
'errorCode' => 'DnsGtmInstance.CnameModeDeny',
'errorMessage' => ' ',
],
[
'errorCode' => 'DnsGtmSystemBusyness',
'errorMessage' => ' ',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF559**\\"\\n}","errorExample":""},{"type":"xml","example":"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925","errorExample":""}]',
'title' => '修改GTM实例全局配置',
'summary' => '通过GTM实例ID修改实例配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateGtmInstanceGlobalConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => 'GTM实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-cs02xyk4a**',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '实例名称。'."\n"
."\n"
.'> 首次更新必填,再次更新则非必填。',
'type' => 'string',
'required' => false,
'example' => '测试实例',
],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => [
'description' => '全局TTL。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
[
'name' => 'UserDomainName',
'in' => 'query',
'schema' => [
'description' => '主域名。'."\n"
.'> 首次更新必填,再次更新非必填。',
'type' => 'string',
'required' => false,
'example' => 'dns-example.top',
],
],
[
'name' => 'LbaStrategy',
'in' => 'query',
'schema' => [
'description' => '均衡策略。取值:'."\n"
."\n"
.'- **ALL_RR**: 负载均摊'."\n"
.'- **RATIO**:加权轮询'."\n"
.'> 首次更新必填,再次更新非必填。',
'type' => 'string',
'required' => false,
'example' => 'RATIO',
],
],
[
'name' => 'AlertGroup',
'in' => 'query',
'schema' => [
'description' => '报警组。目前仅支持一个报警组。'."\n"
."\n"
.'> 首次更新必填,再次更新非必填。',
'type' => 'string',
'required' => false,
'example' => '[\\"研发组\\"]',
],
],
[
'name' => 'CnameMode',
'in' => 'query',
'schema' => [
'description' => '接入方式。取值:'."\n"
.'- **SYSTEM_ASSIGN**:系统分配'."\n"
.'- **CUSTOM**:自定义',
'type' => 'string',
'required' => false,
'example' => 'SYSTEM_ASSIGN',
],
],
[
'name' => 'CnameCustomDomainName',
'in' => 'query',
'schema' => [
'description' => '**CnameMode**为**CUSTOM**接入时必传,必须是主域名。',
'type' => 'string',
'required' => false,
'example' => 'dns-example.top',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'GtmInstance.CnameModeDeny',
'errorMessage' => ' ',
],
[
'errorCode' => 'DnsGtmInstance.CnameModeDeny',
'errorMessage' => ' ',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\r\\n","errorExample":""}]',
'title' => '修改GTM实例全局配置(旧版)',
'summary' => '根据传入参数修改GTM实例配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDnsGtmAccessStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StrategyId',
'in' => 'query',
'schema' => [
'description' => '策略id。可通过调用[DescribeDnsGtmAccessStrategies ](~~2357191~~)获取。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => "\n"
.'hrb**',
],
],
[
'name' => 'StrategyName',
'in' => 'query',
'schema' => [
'description' => '策略名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
[
'name' => 'Lines',
'in' => 'query',
'schema' => [
'description' => '访问区域LineCode列表。例如:`["default", "drpeng"]`,即全局策略和鹏博士。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '["default", "drpeng"]',
],
],
[
'name' => 'DefaultAddrPoolType',
'in' => 'query',
'schema' => [
'description' => '主地址池类型:'."\n"
."\n"
.'- IPV4'."\n"
.'- IPV6'."\n"
.'- DOMAIN(域名)',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IPV4',
],
],
[
'name' => 'DefaultLbaStrategy',
'in' => 'query',
'schema' => [
'description' => '主地址池集合均衡策略:'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'required' => false,
'example' => 'ALL_RR',
],
],
[
'name' => 'DefaultMinAvailableAddrNum',
'in' => 'query',
'schema' => [
'description' => '主地址池集合最小可用地址数量。'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '400',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'DefaultMaxReturnAddrNum',
'in' => 'query',
'schema' => [
'description' => '主地址池集合最多返回地址数量。'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '8',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'DefaultLatencyOptimization',
'in' => 'query',
'schema' => [
'description' => '主地址池集合延时解析调度优化:'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭',
'type' => 'string',
'required' => false,
'example' => 'OPEN',
],
],
[
'name' => 'FailoverAddrPoolType',
'in' => 'query',
'schema' => [
'description' => '备地址池类型:'."\n"
."\n"
.'- IPV4'."\n"
.'- IPV6'."\n"
.'- DOMAIN',
'type' => 'string',
'required' => false,
'example' => 'IPV4',
],
],
[
'name' => 'FailoverLbaStrategy',
'in' => 'query',
'schema' => [
'description' => '备地址池集合均衡策略:'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'required' => false,
'example' => 'ALL_RR',
],
],
[
'name' => 'FailoverMinAvailableAddrNum',
'in' => 'query',
'schema' => [
'description' => '备地址池集合最小可用地址数量。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '400',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'FailoverMaxReturnAddrNum',
'in' => 'query',
'schema' => [
'description' => '备地址池集合最多返回地址数量。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '8',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'FailoverLatencyOptimization',
'in' => 'query',
'schema' => [
'description' => '备地址池集合延时解析调度优化:'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭',
'type' => 'string',
'required' => false,
'example' => 'OPEN',
],
],
[
'name' => 'DefaultAddrPool',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主地址池集合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LbaWeight' => [
'description' => '主地址池集合列表中权重。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Id' => [
'description' => '主地址池集合列表中地址池id。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => 'po***',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'FailoverAddrPool',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '备地址池集合,若未设置备地址池集合,输入"EMPTY"。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LbaWeight' => [
'description' => '备地址池集合列表中权重。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Id' => [
'description' => '备地址池集合列表中地址池id。',
'type' => 'string',
'required' => false,
'example' => 'po**',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'AccessMode',
'in' => 'query',
'schema' => [
'description' => '地址池集合切换策略:'."\n"
."\n"
.'- AUTO: 自动切换'."\n"
.'- DEFAULT:主地址池集合'."\n"
.'- FAILOVER: 备地址池集合',
'type' => 'string',
'required' => false,
'example' => 'DEFAULT',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
'StrategyId' => [
'description' => '策略id。',
'type' => 'string',
'example' => 'testS******',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DnsGtmSystemBusyness',
'errorMessage' => ' ',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\",\\n \\"StrategyId\\": \\"testS******\\"\\n}","errorExample":""},{"type":"xml","example":"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\ntestStrategyId1","errorExample":""}]',
'title' => '修改访问策略',
'summary' => '修改访问策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmAddrAttributeInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '地址类型:'."\n"
."\n"
.'- IPV4:ipv4地址'."\n"
.'- IPV6: ipv6地址'."\n"
.'- DOMAIN:域名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IPV4',
],
],
[
'name' => 'Addrs',
'in' => 'query',
'schema' => [
'description' => '地址列表。'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '['."\n"
.' "1.1.XX.XX"'."\n"
.']',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'Addr' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Addr' => [
'description' => '地址池地址。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AttributeInfo' => [
'description' => '地址归属信息。'."\n"
."\n",
'type' => 'object',
'properties' => [
'FatherCode' => [
'description' => '父线路的code。',
'type' => 'string',
'example' => 'telecom',
],
'GroupName' => [
'description' => '地址归属区域分组名称。',
'type' => 'string',
'example' => 'Global',
],
'LineCode' => [
'description' => '归属线路code。',
'type' => 'string',
'example' => 'default',
],
'LineName' => [
'description' => '地址归属线路名称。',
'type' => 'string',
'example' => 'Global',
],
'GroupCode' => [
'description' => '地址归属区域分组code。',
'type' => 'string',
'example' => 'DEFAULT',
],
],
],
'Addr' => [
'description' => '地址。',
'type' => 'string',
'example' => '1.1.XX.XX',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"Addr\\": {\\n \\"Addr\\": [\\n {\\n \\"AttributeInfo\\": {\\n \\"FatherCode\\": \\"telecom\\",\\n \\"GroupName\\": \\"Global\\",\\n \\"LineCode\\": \\"default\\",\\n \\"LineName\\": \\"Global\\",\\n \\"GroupCode\\": \\"DEFAULT\\"\\n },\\n \\"Addr\\": \\"1.1.XX.XX\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B\\n\\n \\n 1.1.1.1\\n \\n Global\\n DEFAULT\\n telecom\\n default\\n Global\\n \\n \\n","errorExample":""}]',
'title' => '查询地址归属区域信息',
'summary' => '查询地址归属区域。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmAvailableAlertGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'AvailableAlertGroup' => [
'description' => '可设置的报警组。',
'type' => 'string',
'example' => '[\\"测试报警组\\",\\"研发报警组\\"]',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"AvailableAlertGroup\\": \\"[\\\\\\\\\\\\\\"测试报警组\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"研发报警组\\\\\\\\\\\\\\"]\\"\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B\\n[\\"测试报警组\\",\\"研发报警组\\"]","errorExample":""}]',
'title' => '获取GTM实例可用的报警组列表',
'summary' => '获取可设置的报警组。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmInstance' => [
'summary' => '通过实例ID获取实例详情。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsYSO7XZ',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ExpireTimestamp' => [
'description' => '实例到期时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1602656937000',
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '84314904-D047-4176-A0EC-256D7F68C7F5',
],
'ResourceGroupId' => [
'description' => '资源组id。',
'type' => 'string',
'example' => 'resourc*****',
],
'InstanceId' => [
'description' => '实例id。'."\n"
."\n",
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**',
],
'TaskQuota' => [
'description' => '探测任务总数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'Config' => [
'description' => '实例配置信息。'."\n"
."\n",
'type' => 'object',
'properties' => [
'Ttl' => [
'description' => '全局TTL。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'AlertGroup' => [
'description' => '报警组(List的JSON格式)。',
'type' => 'string',
'example' => '["test1","test2"]',
],
'CnameType' => [
'description' => 'cname接入域名类型:'."\n"
."\n"
.'- PUBLIC: 公网型',
'type' => 'string',
'example' => 'PUBLIC',
],
'StrategyMode' => [
'description' => '访问策略模式:'."\n"
."\n"
.'- LATENCY:基于延时'."\n"
.'- GEO:基于地理位置',
'type' => 'string',
'example' => 'GEO',
],
'InstanceName' => [
'description' => '实例名称。'."\n"
."\n",
'type' => 'string',
'example' => 'test',
],
'PublicCnameMode' => [
'description' => '公网cname接入方式:'."\n"
."\n"
.'- CUSTOM: 自定义'."\n"
.'- SYSTEM_ASSIGN: 系统分配(此功能已关闭)',
'type' => 'string',
'example' => 'CUSTOM',
],
'AlertConfig' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AlertConfig' => [
'description' => '报警通知方式。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SmsNotice' => [
'description' => '是否配置短信通知:'."\n"
."\n"
.'- true:已配置'."\n"
.'- false|null : 未配置',
'type' => 'boolean',
'example' => 'true',
],
'NoticeType' => [
'description' => '报警事件类型:'."\n"
."\n"
.'- ADDR_ALERT:地址不可用'."\n"
.'- ADDR_RESUME:地址恢复可用'."\n"
.'- ADDR_POOL_GROUP_UNAVAILABLE:地址池集合不可用'."\n"
.'- ADDR_POOL_GROUP_AVAILABLE:地址池集合恢复可用'."\n"
.'- ACCESS_STRATEGY_POOL_GROUP_SWITCH:主备地址池切换'."\n"
.'- MONITOR_NODE_IP_CHANGE:监控节点IP地址变更',
'type' => 'string',
'example' => 'ADDR_ALERT',
],
'EmailNotice' => [
'description' => '是否配置邮件通知:'."\n"
."\n"
.'- true:已配置'."\n"
.'- false|null : 未配置',
'type' => 'boolean',
'example' => 'true',
],
'DingtalkNotice' => [
'description' => '是否配置钉钉通知:'."\n"
."\n"
.'- true:已配置'."\n"
.'- false|null :未配置',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
'PublicUserDomainName' => [
'description' => '公网用户业务域名。'."\n"
."\n",
'type' => 'string',
'example' => 'example.com',
],
'PubicZoneName' => [
'description' => '公网接入域名。'."\n"
."\n",
'type' => 'string',
'example' => "\n"
.'gtm-cn-wwo3a3hbz**.example.com',
],
'PublicRr' => [
'description' => '公网接入主机名'."\n"
."\n",
'type' => 'string',
'example' => 'test.rr',
],
],
],
'CreateTime' => [
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2020-10-14T06:58Z',
],
'SmsQuota' => [
'description' => '短信通知总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'VersionCode' => [
'description' => '实例版本。',
'type' => 'string',
'example' => 'standard',
],
'PaymentType' => [
'description' => '付费类型'."\n"
."\n"
.'- Subscription:预付费',
'type' => 'string',
'example' => 'Subscription',
],
'ExpireTime' => [
'description' => '到期日。',
'type' => 'string',
'example' => '2020-10-14T06:58Z',
],
'CreateTimestamp' => [
'description' => '实例创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1602656937000',
],
'UsedQuota' => [
'description' => '已使用的配额。'."\n"
."\n",
'type' => 'object',
'properties' => [
'EmailUsedCount' => [
'description' => '已发送邮件总数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '123',
],
'TaskUsedCount' => [
'description' => '已创建探测任务数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '123',
],
'SmsUsedCount' => [
'description' => '已发送短信总数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '123',
],
'DingtalkUsedCount' => [
'description' => '已发送钉钉总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '123',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ExpireTimestamp\\": 1602656937000,\\n \\"RequestId\\": \\"84314904-D047-4176-A0EC-256D7F68C7F5\\",\\n \\"ResourceGroupId\\": \\"resourc*****\\",\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3hbz**\\",\\n \\"TaskQuota\\": 100,\\n \\"Config\\": {\\n \\"Ttl\\": 60,\\n \\"AlertGroup\\": \\"[\\\\\\"test1\\\\\\",\\\\\\"test2\\\\\\"]\\",\\n \\"CnameType\\": \\"PUBLIC\\",\\n \\"StrategyMode\\": \\"GEO\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"PublicCnameMode\\": \\"CUSTOM\\",\\n \\"AlertConfig\\": {\\n \\"AlertConfig\\": [\\n {\\n \\"SmsNotice\\": true,\\n \\"NoticeType\\": \\"ADDR_ALERT\\",\\n \\"EmailNotice\\": true,\\n \\"DingtalkNotice\\": true\\n }\\n ]\\n },\\n \\"PublicUserDomainName\\": \\"example.com\\",\\n \\"PubicZoneName\\": \\"\\\\ngtm-cn-wwo3a3hbz**.example.com\\",\\n \\"PublicRr\\": \\"test.rr\\"\\n },\\n \\"CreateTime\\": \\"2020-10-14T06:58Z\\",\\n \\"SmsQuota\\": 100,\\n \\"VersionCode\\": \\"standard\\",\\n \\"PaymentType\\": \\"Subscription\\",\\n \\"ExpireTime\\": \\"2020-10-14T06:58Z\\",\\n \\"CreateTimestamp\\": 1602656937000,\\n \\"UsedQuota\\": {\\n \\"EmailUsedCount\\": 123,\\n \\"TaskUsedCount\\": 123,\\n \\"SmsUsedCount\\": 123,\\n \\"DingtalkUsedCount\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"1602656937000\\nresourcegroupid1\\n84314904-D047-4176-A0EC-256D7F68C7F5\\ninstanceid1\\n100\\n\\n instancetest1\\n test.rr.gtm-003.com\\n [\\"test1\\",\\"test2\\"]\\n public\\n example.com\\n test.rr\\n GEO\\n 1\\n custom\\n \\n \\n true\\n ADDR_ALERT\\n true\\n true\\n \\n \\n\\n2020-10-14T06:58Z\\n100\\nversioncode1\\nSubscription\\n2020-10-14T06:58Z\\n1602656937000\\n\\n 123\\n 123\\n 123\\n 123\\n","errorExample":""}]',
'title' => '获取GTM实例详情',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmInstance' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => 'GTM实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'instance1',
],
],
[
'name' => 'NeedDetailAttributes',
'in' => 'query',
'schema' => [
'description' => '是否需要额外信息,默认为**false**。取值为**true**时,返回AccessStrategyNum(访问策略个数)、AddressPoolNum(地址池个数)。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ExpireTimestamp' => [
'description' => '实例到期时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1528284856000',
],
'UserDomainName' => [
'description' => '用户域名。',
'type' => 'string',
'example' => 'dns-example.top',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E41AA251-F9BA-48C6-99B2-2B82B26A573A',
],
'LbaStrategy' => [
'description' => '负载均衡策略。'."\n"
.'- **ALL_RR**: 负载均摊'."\n"
.'- **RATIO**: 加权轮询',
'type' => 'string',
'example' => 'RATIO',
],
'InstanceId' => [
'description' => 'GTM实例ID。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**',
],
'CreateTime' => [
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2018-06-06T11:34Z',
],
'CnameMode' => [
'description' => '当前接入方式。其中:'."\n"
."\n"
.'- **SYSTEM_ASSIGN**:系统分配'."\n"
.'- **CUSTOM**:自定义',
'type' => 'string',
'example' => 'CUSTOM',
],
'Ttl' => [
'description' => '全局TTL。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Cname' => [
'description' => 'CNAME接入域名。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**.dns-example.top',
],
'InstanceName' => [
'description' => '实例名称。',
'type' => 'string',
'example' => 'test',
],
'VersionCode' => [
'description' => '版本Code。',
'type' => 'string',
'example' => 'biaozhun',
],
'AlertGroup' => [
'description' => '报警组。',
'type' => 'string',
'example' => '[\\"日常测试-研发组\\"]',
],
'AddressPoolNum' => [
'description' => '地址池个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'AccessStrategyNum' => [
'description' => '访问策略个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'ExpireTime' => [
'description' => '实例到期时间。',
'type' => 'string',
'example' => '2018-06-06T11:34Z',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1528284856000',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-testgroupid',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ExpireTimestamp\\": 1528284856000,\\n \\"UserDomainName\\": \\"dns-example.top\\",\\n \\"RequestId\\": \\"E41AA251-F9BA-48C6-99B2-2B82B26A573A\\",\\n \\"LbaStrategy\\": \\"RATIO\\",\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3hbz**\\",\\n \\"CreateTime\\": \\"2018-06-06T11:34Z\\",\\n \\"CnameMode\\": \\"CUSTOM\\",\\n \\"Ttl\\": 60,\\n \\"Cname\\": \\"gtm-cn-wwo3a3hbz**.dns-example.top\\",\\n \\"InstanceName\\": \\"test\\",\\n \\"VersionCode\\": \\"biaozhun\\",\\n \\"AlertGroup\\": \\"[\\\\\\\\\\\\\\"日常测试-研发组\\\\\\\\\\\\\\"]\\",\\n \\"AddressPoolNum\\": 5,\\n \\"AccessStrategyNum\\": 5,\\n \\"ExpireTime\\": \\"2018-06-06T11:34Z\\",\\n \\"CreateTimestamp\\": 1528284856000,\\n \\"ResourceGroupId\\": \\"rg-testgroupid\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\tinstance1.14.com\\r\\n\\tSYSTEM_ASSIGN\\r\\n\\t1528284856000\\r\\n\\tinstance1\\r\\n\\t1528284856000\\r\\n\\t2018-06-06T11:34Z\\r\\n\\t60\\r\\n\\tE41AA251-F9BA-48C6-99B2-2B82B26A573A\\r\\n\\tbiaozhun\\r\\n\\t2018-06-06T11:34Z\\r\\n\\twww.example.com\\r\\n\\t["日常测试-研发组"]\\r\\n\\t获取实例详情测试\\r\\n\\tRATIO\\r\\n\\t5\\r\\n\\t5\\r\\n","errorExample":""}]',
'title' => '获取GTM实例详情(旧版)',
'summary' => '获取GTM实例的详情信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmInstances' => [
'summary' => '获取实例列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsBCOB1Q',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en,zh,ja。',
'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',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '查询关键字,支持实例ID、实例名称模糊搜索。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-testgroupid',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '84314904-D047-4176-A0EC-256D7F68C7F5',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'GtmInstances' => [
'description' => 'GTM实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PaymentType' => [
'description' => '付费类型:'."\n"
."\n"
.'- Subscription:预付费',
'type' => 'string',
'example' => 'Subscription',
],
'ExpireTime' => [
'description' => '实例到期时间。',
'type' => 'string',
'example' => '2020-10-14T06:58Z',
],
'CreateTime' => [
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2020-10-14T06:58Z',
],
'SmsQuota' => [
'description' => '短信通知总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'InstanceId' => [
'description' => '实例id。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**',
],
'Config' => [
'description' => '实例配置信息。',
'type' => 'object',
'properties' => [
'Ttl' => [
'description' => '全局TTL。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'AlertGroup' => [
'description' => '报警组(List的JSON格式)。',
'type' => 'string',
'example' => '["test1","test2"]',
],
'PublicZoneName' => [
'description' => '公网接入域名。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**.dns-example.top',
],
'CnameType' => [
'description' => 'cname接入域名类型:'."\n"
."\n"
.'- PUBLIC:公网型',
'type' => 'string',
'example' => 'PUBLIC',
],
'StrategyMode' => [
'description' => '访问策略模式:'."\n"
."\n"
.'- LATENCY:基于延时'."\n"
.'- GEO:基于地理位置',
'type' => 'string',
'example' => 'GEO',
],
'InstanceName' => [
'description' => '实例名称。',
'type' => 'string',
'example' => 'instanceTest',
],
'PublicCnameMode' => [
'description' => '公网cname接入方式:'."\n"
."\n"
.'- CUSTOM:自定义'."\n"
.'- SYSTEM_ASSIGN:系统分配(此功能已关闭)',
'type' => 'string',
'example' => 'CUSTOM',
],
'AlertConfig' => [
'description' => '报警通知方式。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SmsNotice' => [
'description' => '是否配置短信通知:'."\n"
."\n"
.'- true:已配置'."\n"
.'- false|null: 未配置',
'type' => 'string',
'example' => 'true',
],
'NoticeType' => [
'description' => '报警事件类型:'."\n"
."\n"
.'- ADDR_ALERT:地址不可用'."\n"
.'- ADDR_RESUME:地址恢复可用'."\n"
.'- ADDR_POOL_GROUP_UNAVAILABLE:地址池集合不可用'."\n"
.'- ADDR_POOL_GROUP_AVAILABLE:地址池集合恢复可用'."\n"
.'- ACCESS_STRATEGY_POOL_GROUP_SWITCH:主备地址池切换',
'type' => 'string',
'example' => 'ADDR_ALERT',
],
'EmailNotice' => [
'description' => '是否配置邮件通知:'."\n"
."\n"
.'- true:已配置'."\n"
.'- false|null:未配置',
'type' => 'string',
'example' => 'true',
],
'DingtalkNotice' => [
'description' => '是否配置钉钉报警通知:'."\n"
."\n"
.'- true:已配置'."\n"
.'- false|null:未配置',
'type' => 'string',
'example' => 'true',
],
],
],
],
'PublicUserDomainName' => [
'description' => '公网用户业务域名。'."\n"
."\n",
'type' => 'string',
'example' => 'dns-example.top',
],
'PublicRr' => [
'description' => '公网接入主机名'."\n",
'type' => 'string',
'example' => 'test.rr',
],
],
],
'ExpireTimestamp' => [
'description' => '实例到期时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1602658709000',
],
'ResourceGroupId' => [
'description' => '资源组Id。',
'type' => 'string',
'example' => 'resourceGroupid123',
],
'VersionCode' => [
'description' => '实例版本。',
'type' => 'string',
'example' => 'standard',
],
'UsedQuota' => [
'description' => '已使用的配额。'."\n"
."\n",
'type' => 'object',
'properties' => [
'EmailUsedCount' => [
'description' => '已发送邮件总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'TaskUsedCount' => [
'description' => '已创建探测任务数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'SmsUsedCount' => [
'description' => '已发送短信总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'DingtalkUsedCount' => [
'description' => '已发送钉钉总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
],
],
'TaskQuota' => [
'description' => '探测任务总数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CreateTimestamp' => [
'description' => '创建时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1602658709000',
],
],
],
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '123',
],
'TotalItems' => [
'description' => '总个数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"84314904-D047-4176-A0EC-256D7F68C7F5\\",\\n \\"PageNumber\\": 1,\\n \\"GtmInstances\\": [\\n {\\n \\"PaymentType\\": \\"Subscription\\",\\n \\"ExpireTime\\": \\"2020-10-14T06:58Z\\",\\n \\"CreateTime\\": \\"2020-10-14T06:58Z\\",\\n \\"SmsQuota\\": 1,\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3hbz**\\",\\n \\"Config\\": {\\n \\"Ttl\\": 60,\\n \\"AlertGroup\\": \\"[\\\\\\"test1\\\\\\",\\\\\\"test2\\\\\\"]\\",\\n \\"PublicZoneName\\": \\"gtm-cn-wwo3a3hbz**.dns-example.top\\",\\n \\"CnameType\\": \\"PUBLIC\\",\\n \\"StrategyMode\\": \\"GEO\\",\\n \\"InstanceName\\": \\"instanceTest\\",\\n \\"PublicCnameMode\\": \\"CUSTOM\\",\\n \\"AlertConfig\\": [\\n {\\n \\"SmsNotice\\": \\"true\\",\\n \\"NoticeType\\": \\"ADDR_ALERT\\",\\n \\"EmailNotice\\": \\"true\\",\\n \\"DingtalkNotice\\": \\"true\\"\\n }\\n ],\\n \\"PublicUserDomainName\\": \\"dns-example.top\\",\\n \\"PublicRr\\": \\"test.rr\\"\\n },\\n \\"ExpireTimestamp\\": 1602658709000,\\n \\"ResourceGroupId\\": \\"resourceGroupid123\\",\\n \\"VersionCode\\": \\"standard\\",\\n \\"UsedQuota\\": {\\n \\"EmailUsedCount\\": 100,\\n \\"TaskUsedCount\\": 100,\\n \\"SmsUsedCount\\": 100,\\n \\"DingtalkUsedCount\\": 100\\n },\\n \\"TaskQuota\\": 1,\\n \\"CreateTimestamp\\": 1602658709000\\n }\\n ],\\n \\"TotalPages\\": 123,\\n \\"TotalItems\\": 100\\n}","errorExample":""},{"type":"xml","example":"84314904-D047-4176-A0EC-256D7F68C7F5\\n1\\n1\\n\\n testVersion1\\n 1602658709000\\n resourceGroupid123\\n instance1\\n 1\\n 2020-10-14T06:58Z\\n Subscription\\n 2020-10-14T06:58Z\\n 1602658709000\\n 1\\n \\n instanceTest\\n [\\"test1\\",\\"test2\\"]\\n public\\n example.com\\n test.rr.gtm-003.com\\n test.rr\\n geo\\n 1\\n custom\\n \\n true\\n ADDR_ALERT\\n true\\n true\\n \\n \\n \\n 100\\n 100\\n 100\\n 100\\n \\n\\n123\\n100","errorExample":""}]',
'title' => '获取GTM实例列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmInstances' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'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',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '查询关键字,支持实例Id,实例名称精确搜索。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-xxxxx',
],
],
[
'name' => 'NeedDetailAttributes',
'in' => 'query',
'schema' => [
'description' => '是否需要额外信息,默认为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '193B0163-7F93-42DF-AB05-ACEEB7D22707',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'GtmInstances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'GtmInstance' => [
'description' => 'GTM实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ExpireTime' => [
'description' => '实例到期时间。',
'type' => 'string',
'example' => '2018-06-06T11:34Z',
],
'AccessStrategyNum' => [
'description' => '访问策略个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'CreateTime' => [
'description' => '实例创建时间。',
'type' => 'string',
'example' => '2018-06-06T11:34Z',
],
'CnameMode' => [
'description' => '当前接入方式。其中:'."\n"
.'- **SYSTEM_ASSIGN**:系统分配'."\n"
.'- **CUSTOM**:自定义',
'type' => 'string',
'example' => 'CUSTOM',
],
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**',
],
'ExpireTimestamp' => [
'description' => '实例到期时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1528284856000',
],
'Ttl' => [
'description' => '全局TTL。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'AlertGroup' => [
'description' => '报警组。',
'type' => 'string',
'example' => '[\\"研发组\\"]',
],
'AddressPoolNum' => [
'description' => '地址池个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'InstanceName' => [
'description' => '实例名称。',
'type' => 'string',
'example' => 'test',
],
'LbaStrategy' => [
'description' => '负载均衡策略。'."\n"
.'- **ALL_RR**: 负载均摊'."\n"
.'- **RATIO**: 加权轮询',
'type' => 'string',
'example' => 'RATIO',
],
'Cname' => [
'description' => 'CNAME接入域名。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**.dns-example.top'."\n",
],
'VersionCode' => [
'description' => '版本Code。',
'type' => 'string',
'example' => 'biaozhun',
],
'UserDomainName' => [
'description' => '用户域名。',
'type' => 'string',
'example' => 'dns-example.top',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1528284856000',
],
'ResourceGroupId' => [
'description' => '资源组ID。',
'type' => 'string',
'example' => 'rg-acfm2q2jqpjh***',
],
],
],
],
],
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"193B0163-7F93-42DF-AB05-ACEEB7D22707\\",\\n \\"PageNumber\\": 1,\\n \\"GtmInstances\\": {\\n \\"GtmInstance\\": [\\n {\\n \\"ExpireTime\\": \\"2018-06-06T11:34Z\\",\\n \\"AccessStrategyNum\\": 5,\\n \\"CreateTime\\": \\"2018-06-06T11:34Z\\",\\n \\"CnameMode\\": \\"CUSTOM\\",\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3hbz**\\",\\n \\"ExpireTimestamp\\": 1528284856000,\\n \\"Ttl\\": 60,\\n \\"AlertGroup\\": \\"[\\\\\\\\\\\\\\"研发组\\\\\\\\\\\\\\"]\\",\\n \\"AddressPoolNum\\": 5,\\n \\"InstanceName\\": \\"test\\",\\n \\"LbaStrategy\\": \\"RATIO\\",\\n \\"Cname\\": \\"gtm-cn-wwo3a3hbz**.dns-example.top\\\\n\\",\\n \\"VersionCode\\": \\"biaozhun\\",\\n \\"UserDomainName\\": \\"dns-example.top\\",\\n \\"CreateTimestamp\\": 1528284856000,\\n \\"ResourceGroupId\\": \\"rg-acfm2q2jqpjh***\\"\\n }\\n ]\\n },\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\t\\r\\n\\t\\t\\tinstance1.14.com\\r\\n\\t\\t\\tSYSTEM_ASSIGN\\r\\n\\t\\t\\t1528284856000\\r\\n\\t\\t\\t2018-06-06T11:34Z\\r\\n\\t\\t\\t60\\r\\n\\t\\t\\t2018-06-06T11:34Z\\r\\n\\t\\t\\tinstance1\\r\\n\\t\\t\\t["研发组"]\\r\\n\\t\\t\\twww.example.com\\r\\n\\t\\t\\t1528284856000\\r\\n\\t\\t\\tRATIO\\r\\n\\t\\t\\t获取实例列表测试\\r\\n\\t\\t\\tbiaozhun\\r\\n\\t\\t\\t5\\r\\n\\t\\t\\t5\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t1\\r\\n\\t20\\r\\n\\t193B0163-7F93-42DF-AB05-ACEEB7D22707\\r\\n\\t1\\r\\n\\t1\\r\\n","errorExample":""}]',
'title' => '获取GTM实例列表(旧版)',
'summary' => '获取GTM实例列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmInstanceStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'StrategyNotAvailableNum' => [
'description' => '当前生效地址池集合不可用的访问策略个数。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AddrAvailableNum' => [
'description' => '正常地址个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA',
],
'SwitchToFailoverStrategyNum' => [
'description' => '切换到备用地址池集合的访问策略个数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AddrNotAvailableNum' => [
'description' => '故障地址个数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AddrPoolGroupNotAvailableNum' => [
'description' => '不可用地址池集合个数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"StrategyNotAvailableNum\\": 1,\\n \\"AddrAvailableNum\\": 1,\\n \\"RequestId\\": \\"389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA\\",\\n \\"SwitchToFailoverStrategyNum\\": 1,\\n \\"AddrNotAvailableNum\\": 1,\\n \\"AddrPoolGroupNotAvailableNum\\": 1\\n}","errorExample":""},{"type":"xml","example":"1\\n1\\n389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA\\n1\\n1\\n1","errorExample":""}]',
'title' => '获取GTM实例状态',
'summary' => '通过实例ID获取实例当前状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmInstanceStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '实例状态:'."\n"
."\n"
.'- ALLOW:允许操作'."\n"
.'- DENY:不允许操作',
'type' => 'string',
'example' => 'ALLOW',
],
'StrategyNotAvailableNum' => [
'description' => '当前生效地址池不可用的访问策略个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA',
],
'SwitchToFailoverStrategyNum' => [
'description' => '切换到备用地址池的访问策略个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'StatusReason' => [
'description' => '实例状态原因列表'."\n"
."\n"
.'- INSTANCE_OPERATE_BLACK_LIST:黑名单'."\n"
.'- BETA_INSTANCE:公测期实例'."\n",
'type' => 'string',
'example' => '["BETA_INSTANCE"]',
],
'AddrNotAvailableNum' => [
'description' => '故障地址个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'AddrPoolNotAvailableNum' => [
'description' => '不可用地址池个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"ALLOW\\",\\n \\"StrategyNotAvailableNum\\": 10,\\n \\"RequestId\\": \\"389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA\\",\\n \\"SwitchToFailoverStrategyNum\\": 10,\\n \\"StatusReason\\": \\"[\\\\\\"BETA_INSTANCE\\\\\\"]\\",\\n \\"AddrNotAvailableNum\\": 10,\\n \\"AddrPoolNotAvailableNum\\": 10\\n}","errorExample":""},{"type":"xml","example":"389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA\\n10\\n10\\n10\\n10\\nDENY\\n[\\"BETA_INSTANCE\\"]","errorExample":""}]',
'title' => '获取GTM实例状态(旧版)',
'summary' => '获取实例的当前状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'DescribeDnsGtmLogs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '关键字,按照”%KeyWord%”模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'demo',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。'."\n"
."\n",
'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' => 'StartTimestamp',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '999999999999999',
'minimum' => '1',
'example' => '1516779348000',
],
],
[
'name' => 'EndTimestamp',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'maximum' => '999999999999999',
'minimum' => '1',
'example' => '1516779348000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '50C60A29-2E93-425A-ABA8-068686E28873',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Logs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Log' => [
'description' => '日志列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OperTimestamp' => [
'description' => '操作时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1516779348000',
],
'EntityId' => [
'description' => '操作对象Id。'."\n"
."\n",
'type' => 'string',
'example' => '121*****',
],
'EntityType' => [
'description' => '操作的对象类型。'."\n"
."\n",
'type' => 'string',
'example' => '地址池',
],
'OperTime' => [
'description' => '操作时间。'."\n"
."\n",
'type' => 'string',
'example' => '2018-01-24T07:35Z',
],
'OperAction' => [
'description' => '操作的动作。'."\n"
."\n",
'type' => 'string',
'example' => '增加',
],
'Content' => [
'description' => '格式化的消息内容。'."\n"
."\n",
'type' => 'string',
'example' => 'addtest-pool-1',
],
'EntityName' => [
'description' => '操作对象名称。'."\n"
."\n",
'type' => 'string',
'example' => 'test-pool-1',
],
'Id' => [
'description' => '记录Id。'."\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '67****',
],
],
],
],
],
],
'TotalItems' => [
'description' => '总个数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"50C60A29-2E93-425A-ABA8-068686E28873\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"Logs\\": {\\n \\"Log\\": [\\n {\\n \\"OperTimestamp\\": 1516779348000,\\n \\"EntityId\\": \\"121*****\\",\\n \\"EntityType\\": \\"地址池\\",\\n \\"OperTime\\": \\"2018-01-24T07:35Z\\",\\n \\"OperAction\\": \\"增加\\",\\n \\"Content\\": \\"addtest-pool-1\\",\\n \\"EntityName\\": \\"test-pool-1\\",\\n \\"Id\\": 0\\n }\\n ]\\n },\\n \\"TotalItems\\": 1\\n}","errorExample":""},{"type":"xml","example":"1\\n50C60A29-2E93-425A-ABA8-068686E28873\\n1\\n1\\n\\n \\n 121212\\n 地址池\\n test-pool-1\\n 2018-01-24T07:35Z\\n addtest-pool-1\\n 1516779348000\\n 6726\\n 增加\\n \\n\\n1","errorExample":""}]',
'title' => '获取GTM操作日志列表',
'summary' => '通过实例ID获取操作日志列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmAvailableAlertGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
'AvailableAlertGroup' => [
'description' => '可用报警组。',
'type' => 'string',
'example' => '[\\"研发组\\",\\"GTM测试组\\"]',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\",\\n \\"AvailableAlertGroup\\": \\"[\\\\\\\\\\\\\\"研发组\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"GTM测试组\\\\\\\\\\\\\\"]\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\r\\n\\t["研发组","GTM测试组"]\\r\\n","errorExample":""}]',
'title' => '获取GTM实例可用的报警组列表(旧版)',
'summary' => '获取GTM实例可用的报警组列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmLogs' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '用户语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-xxxxx',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '关键字,按照“%Keyword%”模式搜索,不区分大小写。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'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' => 'StartTimestamp',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1363453340000',
],
],
[
'name' => 'EndTimestamp',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1363453340000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '页面大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '50C60A29-2E93-425A-ABA8-068686E28873',
],
'PageNumber' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '224',
],
'Logs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Log' => [
'description' => '日志列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OperTimestamp' => [
'description' => '操作时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1516779348000',
],
'EntityId' => [
'description' => '操作对象ID',
'type' => 'string',
'example' => '121212',
],
'EntityType' => [
'description' => '操作的对象类型',
'type' => 'string',
'example' => 'POOL',
],
'OperTime' => [
'description' => '操作时间',
'type' => 'string',
'example' => '2018-01-24T07:35Z',
],
'OperIp' => [
'description' => '操作ip',
'type' => 'string',
'example' => '106.11.34.X',
],
'OperAction' => [
'description' => '操作的动作',
'type' => 'string',
'example' => 'add',
],
'Content' => [
'description' => '格式化的消息内容',
'type' => 'string',
'example' => 'addtest-pool-1',
],
'EntityName' => [
'description' => '操作对象名称',
'type' => 'string',
'example' => 'test-pool-1',
],
'Id' => [
'description' => '记录ID',
'type' => 'integer',
'format' => 'int64',
'example' => '6726',
],
],
],
],
],
],
'TotalItems' => [
'description' => '总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '224',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"50C60A29-2E93-425A-ABA8-068686E28873\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 224,\\n \\"Logs\\": {\\n \\"Log\\": [\\n {\\n \\"OperTimestamp\\": 1516779348000,\\n \\"EntityId\\": \\"121212\\",\\n \\"EntityType\\": \\"POOL\\",\\n \\"OperTime\\": \\"2018-01-24T07:35Z\\",\\n \\"OperIp\\": \\"106.11.34.X\\",\\n \\"OperAction\\": \\"add\\",\\n \\"Content\\": \\"addtest-pool-1\\",\\n \\"EntityName\\": \\"test-pool-1\\",\\n \\"Id\\": 6726\\n }\\n ]\\n },\\n \\"TotalItems\\": 224\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\r\\n\\t\\taddtest-pool-1\\r\\n\\t\\t121212\\r\\n\\t\\ttest-pool-1\\r\\n\\t\\t6726\\r\\n\\t\\tadd\\r\\n\\t\\t106.11.34.X\\r\\n\\t\\tPOOL\\r\\n\\t\\t2018-01-24T07:35Z\\r\\n\\t\\t1516779348000\\r\\n\\t\\r\\n\\t1\\r\\n\\t1\\r\\n\\t50C60A29-2E93-425A-ABA8-068686E28873\\r\\n\\t224\\r\\n\\t224\\r\\n","errorExample":""}]',
'title' => '获取GTM操作日志列表(旧版)',
'summary' => '获取日志列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmInstanceSystemCname' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '用户语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SystemCname' => [
'description' => '系统分配cname域名。',
'type' => 'string',
'example' => 'gtm-cn-mp91004xxxx.gtm-a2**.com',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SystemCname\\": \\"gtm-cn-mp91004xxxx.gtm-a2**.com\\",\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n\\tgtm-cn-mp91004xxxx.gtm-a2b4.com\\r\\n","errorExample":""}]',
'title' => '获取系统分配的CNAME域名(旧版)',
'summary' => '获取系统分配的cname域名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmInstanceSystemCname' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SystemCname' => [
'description' => '系统分配cname域名。'."\n"
."\n",
'type' => 'string',
'example' => 'gtm-cn-mp91004xxxx.gtm-a2**.com',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SystemCname\\": \\"gtm-cn-mp91004xxxx.gtm-a2**.com\\",\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B\\ngtminstance.com","errorExample":""}]',
'title' => '获取系统分配的CNAME域名',
'summary' => '通过实例ID获取系统分配的CNAME域名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CopyGtmConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'SourceId',
'in' => 'query',
'schema' => [
'description' => '源对象Id,目前仅支持实例id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-0pp1j84v60d',
],
],
[
'name' => 'TargetId',
'in' => 'query',
'schema' => [
'description' => '目标对象Id,目前仅支持实例id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-v0h1gaujg06',
],
],
[
'name' => 'CopyType',
'in' => 'query',
'schema' => [
'description' => '复制类型,目前仅支持INSTANCE。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'INSTANCE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA\\"\\n}","errorExample":""},{"type":"xml","example":"389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA","errorExample":""}]',
'title' => '复制GTM配置',
'summary' => '复制GTM配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'MoveGtmResourceGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'rg-aekzzk7hx3*****',
],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'AgIDE1MA_XXX',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n C6F1D541-E7A6-447A-A2B5-9F7A20B2A8FB\\r\\n","errorExample":""}]',
'title' => '修改GTM实例的资源组ID',
'summary' => '根据传入参数修改GTM实例的资源组ID。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ValidateDnsGtmCnameRrCanUse' => [
'summary' => '检查实例主机名是否可添加',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'CnameRr',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'CnameType',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'CnameMode',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'CnameZone',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'AddGtmAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '用户语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-xxxxxxx',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '地址池名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '测试',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '地址池类型。取值:'."\n"
."\n"
.'- **IP**:IPv4地址'."\n"
.'- **DOMAIN**:域名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IP',
],
],
[
'name' => 'MinAvailableAddrNum',
'in' => 'query',
'schema' => [
'description' => '最小可用地址数量。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'MonitorStatus',
'in' => 'query',
'schema' => [
'description' => '健康检查开启状态。取值:'."\n"
."\n"
.'- **OPEN**:开启'."\n"
.'- **CLOSE**(默认):关闭',
'type' => 'string',
'required' => false,
'example' => 'OPEN',
],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '检查协议。取值:'."\n"
."\n"
.'- HTTP'."\n"
.'- HTTPS'."\n"
.'- Ping'."\n"
.'- TCP',
'type' => 'string',
'required' => false,
'example' => 'TCP',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '检查间隔,单位:秒,取值范围:60。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => [
'description' => '连续失败次数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => [
'description' => '超时时间,单位:毫秒,取值范围:2000、3000、5000、10000。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5000',
],
],
[
'name' => 'MonitorExtendInfo',
'in' => 'query',
'schema' => [
'description' => '扩展信息。根据不同协议,进行传参:'."\n"
."\n"
.'HTTP、HTTPS:'."\n"
.' '."\n"
.'- port:检查端口'."\n"
.'- failureRate:失败比例'."\n"
.'- code:返回码(大于此值会被判定为异常)。取值:400、500。'."\n"
.'- host:Host设置'."\n"
.'- path:URL路径'."\n"
."\n"
.'PING:'."\n"
."\n"
.'- packetNum:ping包数目'."\n"
.'- packetLossRate:丢包率'."\n"
.'- failureRate:失败比例'."\n"
."\n"
.'TCP:'."\n"
."\n"
.'- port:检查端口'."\n"
.'- failureRate:失败比例',
'type' => 'string',
'required' => false,
'example' => '{"host":"aliyun.com","port":80}',
],
],
[
'name' => 'Addr',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Value' => [
'description' => '地址池地址。',
'type' => 'string',
'required' => false,
'example' => '1.1.XX.XX',
],
'LbaWeight' => [
'description' => '地址池权重。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Mode' => [
'description' => '地址池模式。取值:'."\n"
."\n"
.'- **SMART**:智能返回'."\n"
.'- **ONLINE**:永远在线'."\n"
.'- **OFFLINE**:永远离线',
'type' => 'string',
'required' => false,
'example' => 'SMART',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 50,
],
],
[
'name' => 'IspCityNode',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '监控城市节点列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '监控节点的城市Code。具体取值请参考DescribeGtmMonitorAvailableConfig的返回值。',
'type' => 'string',
'required' => false,
'example' => '546',
],
'IspCode' => [
'description' => '- 具体取值可参考:DescribeGtmMonitorAvailableConfig接口返回数据。'."\n"
.'- GroupType为BGP或Overseas时,IspCityNode.N.IspCode为非必传值,默认为465。'."\n"
.'- GroupType为非BGP或Overseas时,IspCityNode.N.IspCode为必传值。并与IspCityNode.N.CityCode匹配使用。',
'type' => 'string',
'required' => false,
'example' => '465',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'AddrPoolId' => [
'description' => '地址池ID。',
'type' => 'string',
'example' => 'hraf3x',
],
'MonitorConfigId' => [
'description' => '健康检查配置ID。',
'type' => 'string',
'example' => 'hraf14',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"AddrPoolId\\": \\"hraf3x\\",\\n \\"MonitorConfigId\\": \\"hraf14\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n 6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n\\thraf3x\\r\\n\\thraf14\\r\\n","errorExample":""}]',
'title' => '新增地址池(旧版)',
'summary' => '新增地址池。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddDnsGtmAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-cs02xyk****',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '地址池名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '地址池类型:'."\n"
."\n"
.'- IPV4:ipv4地址'."\n"
.'- IPV6: ipv6地址'."\n"
.'- DOMAIN:域名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IPV4',
],
],
[
'name' => 'LbaStrategy',
'in' => 'query',
'schema' => [
'description' => '负载均衡状态:'."\n"
."\n"
.'- ALL_RR:返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ALL_RR',
],
],
[
'name' => 'MonitorStatus',
'in' => 'query',
'schema' => [
'description' => '健康检查开启状态(默认CLOSE),若OPEN则校验健康检查配置,否则抛弃'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭',
'type' => 'string',
'required' => false,
'example' => 'OPEN',
],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '检查协议:'."\n"
."\n"
.'- HTTP'."\n"
.'- HTTPS'."\n"
.'- PING'."\n"
.'- TCP',
'type' => 'string',
'required' => false,
'example' => 'TCP',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '检查间隔,单位秒。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '9999999',
'minimum' => '1',
'example' => '60',
],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => [
'description' => '连续失败次数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '9999999',
'minimum' => '1',
'example' => '2',
],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => [
'description' => '超时时间,单位毫秒。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '9999999',
'minimum' => '1',
'example' => '2000',
],
],
[
'name' => 'MonitorExtendInfo',
'in' => 'query',
'schema' => [
'description' => '扩展信息,各协议检查所需参数:'."\n"
.'- HTTP(S):'."\n"
."\n"
.' - port:检查端口'."\n"
.' - host:Host设置'."\n"
.' - path:URL路径'."\n"
.' - code:返回码(大于此值会被判定为异常)。取值:400、500。'."\n"
.' - failureRate:失败比例'."\n"
.' - sni:是否开启sni,仅在HTTPS协议时使用。'."\n"
.' - true-开启'."\n"
.' - 其他-未开启'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
."\n"
.'- PING:'."\n"
."\n"
.' - failureRate:失败比例'."\n"
.' - packetNum:ping包数目'."\n"
.' - packetLossRate:丢包率'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
."\n"
.'- TCP:'."\n"
."\n"
.' - port:检查端口'."\n"
.' - failureRate:失败比例'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6',
'type' => 'string',
'required' => false,
'example' => '{"failureRate":50,"port":80}',
],
],
[
'name' => 'Addr',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AttributeInfo' => [
'description' => '地址归属信息, JSON字符串格式。'."\n"
."\n"
.'- lineCode:归属线路Code'."\n"
.'- lineCodeRectifyType:归属线路订正类型,默认:自动订正'."\n"
.' - NO_NEED 不订正'."\n"
.' - RECTIFIED 已订正'."\n"
.' - AUTO 自动订正',
'type' => 'string',
'required' => true,
'example' => '{"lineCodeRectifyType":"AUTO", "lineCode":[]}',
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'LbaWeight' => [
'description' => '权重。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Addr' => [
'description' => '地址。',
'type' => 'string',
'required' => true,
'example' => '223.5.XX.XX',
],
'Mode' => [
'description' => '模式:'."\n"
."\n"
.'- SMART:智能返回'."\n"
.'- ONLINE:永远在线'."\n"
.'- OFFLINE:永远离线',
'type' => 'string',
'required' => true,
'example' => 'SMART',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 50,
],
],
[
'name' => 'IspCityNode',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '监控城市节点列表。当 MonitorStatus 为 OPEN 状态时,节点列表中至少应配置一个有效节点。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市Code。当 MonitorStatus 为 OPEN 状态时,CityCode不能为空。'."\n"
."\n"
.'具体取值可参考:DescribeDnsGtmMonitorAvailableConfig接口返回数据。',
'type' => 'string',
'required' => false,
'example' => '503',
],
'IspCode' => [
'description' => '当 MonitorStatus 为 OPEN 状态时,IspCode不能为空。'."\n"
.'具体取值可参考:DescribeDnsGtmMonitorAvailableConfig接口返回数据。',
'type' => 'string',
'required' => false,
'example' => '465',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD5799335**B',
],
'AddrPoolId' => [
'description' => '地址池id。',
'type' => 'string',
'example' => 'hrbv**',
],
'MonitorConfigId' => [
'description' => '健康检查配置id。'."\n"
."\n",
'type' => 'string',
'example' => 'hra**a',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DnsGtmSystemBusyness',
'errorMessage' => ' ',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD5799335**B\\",\\n \\"AddrPoolId\\": \\"hrbv**\\",\\n \\"MonitorConfigId\\": \\"hra**a\\"\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B\\ntestpool1\\ntest1","errorExample":""}]',
'title' => '新增地址池',
'summary' => '新增地址池。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteDnsGtmAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'AddrPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池id。可通过调用[DescribeDnsGtmInstanceAddressPools ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspools?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_9_7.1cee430dbd1I3y)获取'."\n"
.'可通过调用[DescribeDnsGtmInstanceAddressPools ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspools?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testp******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DnsGtmSystemBusyness',
'errorMessage' => ' ',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B","errorExample":""}]',
'title' => '删除 DNS 地址池',
'summary' => '通过地址池ID删除地址池。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteGtmAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'AddrPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1234',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n","errorExample":""}]',
'title' => '删除地址池(旧版)',
'summary' => '删除地址池。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDnsGtmAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'AddrPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池id。可通过调用[DescribeDnsGtmInstanceAddressPools ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspools?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_9_7.1cee430dbd1I3y)获取'."\n"
.'可通过调用[DescribeDnsGtmInstanceAddressPools ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspools?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testp******',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '地址池名称。',
'type' => 'string',
'required' => false,
'example' => 'testpoolname',
],
],
[
'name' => 'LbaStrategy',
'in' => 'query',
'schema' => [
'description' => '负载均衡策略:'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ALL_RR',
],
],
[
'name' => 'Addr',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AttributeInfo' => [
'description' => '地址归属信息,JSON化字符串格式。'."\n"
."\n"
.'- LineCode:归属线路Code(已废弃,以lineCodes数据为准)'."\n"
.'- lineCodes:归属线路Code列表'."\n"
.'- lineCodeRectifyType:归属线路订正类型,默认:自动订正'."\n"
.' - NO_NEED 不订正'."\n"
.' - RECTIFIED 已订正'."\n"
.' - AUTO 自动订正'."\n"
.' '."\n"
."\n\n"
."\n",
'type' => 'string',
'required' => false,
'example' => 'Linecode: default'."\n"
.'lineCodes: ["default"]'."\n"
.'lineCodeRectifyType: AUTO',
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
'LbaWeight' => [
'description' => '权重。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Addr' => [
'description' => '地址。',
'type' => 'string',
'required' => true,
'example' => '1.1.XX.XX',
],
'Mode' => [
'description' => '模式:'."\n"
."\n"
.'- SMART:智能返回'."\n"
.'- ONLINE:永远在线'."\n"
.'- OFFLINE:永远离线',
'type' => 'string',
'required' => true,
'example' => 'SMART',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DnsGtmSystemBusyness',
'errorMessage' => ' ',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B","errorExample":""}]',
'title' => '修改地址池',
'summary' => '根据填写的参数修改地址池。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateGtmAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'AddrPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1234abc',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '地址池名称。',
'type' => 'string',
'required' => false,
'example' => '名称',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '地址池类型:'."\n"
."\n"
.'- IP:ipv4地址'."\n"
.'- DOMAIN:域名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IP',
],
],
[
'name' => 'MinAvailableAddrNum',
'in' => 'query',
'schema' => [
'description' => '最小可用地址数量',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'Addr',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Value' => [
'description' => '地址池地址。',
'type' => 'string',
'required' => false,
'example' => '1.1.XX.XX',
],
'LbaWeight' => [
'description' => '地址池权重。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Mode' => [
'description' => '模式。'."\n"
.'- **SMART**:智能返回'."\n"
.'- **ONLINE**:永远在线'."\n"
.'- **OFFLINE**:永远离线',
'type' => 'string',
'required' => false,
'example' => 'SMART',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求标识。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n","errorExample":""}]',
'title' => '修改地址池(旧版)',
'summary' => '修改地址池。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmInstanceAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'AddrPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池id。可通过调用[DescribeDnsGtmInstanceAddressPools ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspools?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_9_7.1cee430dbd1I3y)获取'."\n"
.'可通过调用[DescribeDnsGtmInstanceAddressPools ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspools?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Addrs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Addr' => [
'description' => '地址池地址。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'AttributeInfo' => [
'description' => '地址归属信息。'."\n"
."\n"
.'- LineCode:归属线路code。(已废弃,以LineCodes数据为准)'."\n"
.'- LineName:归属线路名称。(已废弃)'."\n"
.'- LineCodes:归属线路列表。'."\n"
."\n\n"
."\n\n"
."\n\n"
."\n",
'type' => 'string',
'example' => '"LineCode":"aliyun_r_cn-zhangjiakou", "LineName": "阿里云_华北3(张家口)",“LineCodes”:["aliyun_r_cn-zhangjiakou"]',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'AlertStatus' => [
'description' => '健康检查状态:'."\n"
."\n"
.'- OK:正常'."\n"
.'- ALERT:报警',
'type' => 'string',
'example' => 'OK',
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'example' => 'test',
],
'LbaWeight' => [
'description' => '权重。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Addr' => [
'description' => 'IP地址。',
'type' => 'string',
'example' => '1.1.XX.XX',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'Mode' => [
'description' => '模式:'."\n"
."\n"
.'- SMART:智能返回'."\n"
.'- ONLINE:永远在线'."\n"
.'- OFFLINE:永远离线',
'type' => 'string',
'example' => 'SMART',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
],
],
],
],
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'LbaStrategy' => [
'description' => '负载均衡策略:'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'example' => 'ALL_RR',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'AddrCount' => [
'description' => '地址池数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Name' => [
'description' => '地址池名称。'."\n"
."\n",
'type' => 'string',
'example' => 'test',
],
'Type' => [
'description' => '地址池类型:'."\n"
."\n"
.'- IPV4:ipv4地址'."\n"
.'- IPV6: ipv6地址'."\n"
.'- DOMAIN:域名',
'type' => 'string',
'example' => 'IPV4',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'AddrPoolId' => [
'description' => '地址池id。',
'type' => 'string',
'example' => 'test*****',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'MonitorConfigId' => [
'description' => '监控配置id。'."\n"
."\n",
'type' => 'string',
'example' => 'test1',
],
'MonitorStatus' => [
'description' => '监控状态:'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭'."\n"
.'- UNCONFIGURED:未配置',
'type' => 'string',
'example' => 'OPEN',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Addrs\\": {\\n \\"Addr\\": [\\n {\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"AttributeInfo\\": \\"\\\\\\"LineCode\\\\\\":\\\\\\"aliyun_r_cn-zhangjiakou\\\\\\", \\\\\\"LineName\\\\\\": \\\\\\"阿里云_华北3(张家口)\\\\\\",“LineCodes”:[\\\\\\"aliyun_r_cn-zhangjiakou\\\\\\"]\\",\\n \\"UpdateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"AlertStatus\\": \\"OK\\",\\n \\"Remark\\": \\"test\\",\\n \\"LbaWeight\\": 1,\\n \\"Addr\\": \\"1.1.XX.XX\\",\\n \\"CreateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"Mode\\": \\"SMART\\",\\n \\"CreateTimestamp\\": 1527690629357\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"LbaStrategy\\": \\"ALL_RR\\",\\n \\"CreateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"AddrCount\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"IPV4\\",\\n \\"UpdateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"AddrPoolId\\": \\"test*****\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"MonitorConfigId\\": \\"test1\\",\\n \\"MonitorStatus\\": \\"OPEN\\",\\n \\"CreateTimestamp\\": 1527690629357\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\"LineCode\\":\\"aliyun_r_cn-zhangjiakou\\", \\"LineName\\": \\"阿里云_华北3(张家口)\\",“LineCodes”:[\\"aliyun_r_cn-zhangjiakou\\"]\\n 1\\n ok\\n online\\n 2017-12-28T13:08Z\\n 2017-12-28T13:08Z\\n 1527690629357\\n 1527690629357\\n 1.1.1.1\\n test\\n \\n\\nall_rr\\n6856BCF6-11D6-4D7E-AC53-FD579933522B\\n2017-12-28T13:08Z\\ntest\\n1\\nipv4\\n2017-12-28T13:08Z\\ntestpool1\\n1527690629357\\ntest1\\nopen\\n1527690629357","errorExample":""}]',
'title' => '获取地址池详情',
'summary' => '通过地址池ID获取地址池详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmInstanceAddressPools' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。'."\n"
."\n",
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '总页数。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddrPool' => [
'description' => '地址池列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '地址池类型:'."\n"
."\n"
.'- IPV4:ipv4地址'."\n"
.'- IPV6:ipv6地址'."\n"
.'- DOMAIN:域名',
'type' => 'string',
'example' => 'IPV4',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'MonitorStatus' => [
'description' => '监控状态:'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭'."\n"
.'- UNCONFIGURED:未配置',
'type' => 'string',
'example' => 'OPEN',
],
'UpdateTime' => [
'description' => '更新时间。'."\n"
."\n",
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'AddrPoolId' => [
'description' => '地址池id。'."\n"
."\n",
'type' => 'string',
'example' => 'hr****',
],
'LbaStrategy' => [
'description' => '负载均衡策略'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'example' => 'ALL_RR',
],
'Name' => [
'description' => '地址池名称。'."\n"
."\n",
'type' => 'string',
'example' => 'testpool',
],
'AddrCount' => [
'description' => '地址数量。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'MonitorConfigId' => [
'description' => '监控配置id。'."\n"
."\n",
'type' => 'string',
'example' => 'abc****',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1,\\n \\"AddrPools\\": {\\n \\"AddrPool\\": [\\n {\\n \\"Type\\": \\"IPV4\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"MonitorStatus\\": \\"OPEN\\",\\n \\"UpdateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"CreateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"AddrPoolId\\": \\"hr****\\",\\n \\"LbaStrategy\\": \\"ALL_RR\\",\\n \\"Name\\": \\"testpool\\",\\n \\"AddrCount\\": 1,\\n \\"MonitorConfigId\\": \\"abc****\\",\\n \\"CreateTimestamp\\": 1527690629357\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"1\\n6856BCF6-11D6-4D7E-AC53-FD579933522B\\n1\\n1\\n1\\n\\n \\n ipv4\\n all_rr\\n 2017-12-28T13:08Z\\n 2017-12-28T13:08Z\\n pool-1\\n 1527690629357\\n abc123\\n open\\n 1527690629357\\n testpool\\n 1\\n \\n","errorExample":""}]',
'title' => '获取地址池列表',
'summary' => '通过GTM实例ID获取地址池列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmAddressPoolAvailableConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '199C3699-9A7B-41A1-BB5A-F1E862D3CB38',
],
'AttributeInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AttributeInfo' => [
'description' => '支持的地址归属区域列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FatherCode' => [
'description' => '地址归属区域父节点线路Code。',
'type' => 'string',
'example' => 'telecom',
],
'GroupName' => [
'description' => '地址归属区域分组名称。'."\n"
."\n",
'type' => 'string',
'example' => 'ISP',
],
'LineCode' => [
'description' => '地址归属区域线路Code。'."\n"
."\n",
'type' => 'string',
'example' => 'cn_telecom_jiangxi',
],
'LineName' => [
'description' => '地址归属区域线路名称。'."\n"
."\n",
'type' => 'string',
'example' => 'ChinaTelecom_jiangxi',
],
'GroupCode' => [
'description' => '地址归属区域分组Code。'."\n"
."\n",
'type' => 'string',
'example' => 'ISP',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"199C3699-9A7B-41A1-BB5A-F1E862D3CB38\\",\\n \\"AttributeInfos\\": {\\n \\"AttributeInfo\\": [\\n {\\n \\"FatherCode\\": \\"telecom\\",\\n \\"GroupName\\": \\"ISP\\",\\n \\"LineCode\\": \\"cn_telecom_jiangxi\\",\\n \\"LineName\\": \\"ChinaTelecom_jiangxi\\",\\n \\"GroupCode\\": \\"ISP\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"199C3699-9A7B-41A1-BB5A-F1E862D3CB38\\n\\n \\n global\\n default\\n telecom\\n default\\n global\\n \\n","errorExample":""}]',
'title' => '获取地址池可设置配置信息',
'summary' => '通过GTM实例ID获取地址池可设置配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmInstanceAddressPool' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'AddrPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hrbpnf',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '地址池可用状态。其中:'."\n"
."\n"
.'- **AVAILABLE**:可用'."\n"
.'- **NOT_AVAILABLE**:不可用',
'type' => 'string',
'example' => 'AVAILABLE',
],
'Addrs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Addr' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Value' => [
'description' => 'IP地址。',
'type' => 'string',
'example' => '1.1.XX.XX',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'AlertStatus' => [
'description' => '健康检查状态。其中:'."\n"
."\n"
.'- **OK**:正常'."\n"
.'- **ALERT**:报警',
'type' => 'string',
'example' => 'OK',
],
'LbaWeight' => [
'description' => '权重。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'AddrId' => [
'description' => '地址ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123',
],
'Mode' => [
'description' => '返回模式。其中:'."\n"
."\n"
.'- **SMART**:智能返回'."\n"
.'- **ONLINE**:永远在线'."\n"
.'- **OFFLINE**:永远离线',
'type' => 'string',
'example' => 'SMART',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
],
],
],
],
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'AddrCount' => [
'description' => '地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Name' => [
'description' => '地址池名称。',
'type' => 'string',
'example' => '名称',
],
'Type' => [
'description' => '地址池类型。其中:'."\n"
."\n"
.'- **IP**:IP地址'."\n"
.'- **DOMAIN**:域名',
'type' => 'string',
'example' => 'IP',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'AddrPoolId' => [
'description' => '地址池ID。',
'type' => 'string',
'example' => '1234abc',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'MonitorConfigId' => [
'description' => '监控配置ID。',
'type' => 'string',
'example' => '100abc',
],
'MinAvailableAddrNum' => [
'description' => '最小可用地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'MonitorStatus' => [
'description' => '监控状态。其中:'."\n"
.'- **OPEN**:开启'."\n"
.'- **CLOSE**:关闭'."\n"
.'- **UNCONFIGURED**:未配置',
'type' => 'string',
'example' => 'OPEN',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"Addrs\\": {\\n \\"Addr\\": [\\n {\\n \\"Value\\": \\"1.1.XX.XX\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"AlertStatus\\": \\"OK\\",\\n \\"LbaWeight\\": 1,\\n \\"CreateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"AddrId\\": 123,\\n \\"Mode\\": \\"SMART\\",\\n \\"CreateTimestamp\\": 1527690629357\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"CreateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"AddrCount\\": 2,\\n \\"Name\\": \\"名称\\",\\n \\"Type\\": \\"IP\\",\\n \\"UpdateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"AddrPoolId\\": \\"1234abc\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"MonitorConfigId\\": \\"100abc\\",\\n \\"MinAvailableAddrNum\\": 1,\\n \\"MonitorStatus\\": \\"OPEN\\",\\n \\"CreateTimestamp\\": 1527690629357\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n\\t1234abc\\r\\n\\t2017-12-28T13:08Z\\r\\n\\t1527690629357\\r\\n\\t2\\r\\n\\t2\\r\\n\\t100abc\\r\\n\\tOPEN\\r\\n\\t名称测试1\\r\\n\\tAVAILABLE\\r\\n\\tIP\\r\\n\\t2018-01-03T08:57Z\\r\\n\\t1527690629357\\r\\n\\t\\r\\n\\t\\t123\\r\\n\\t\\t2017-12-28T13:08Z\\r\\n\\t\\t1527690629357\\r\\n\\t\\t2018-01-03T08:57Z\\r\\n\\t\\t1527690629357\\r\\n\\t\\t1.1.1.1\\r\\n\\t\\t1\\r\\n\\t\\tSMART\\r\\n\\t\\tOK\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t234\\r\\n\\t\\t2017-12-28T13:08Z\\r\\n\\t\\t1527690629357\\r\\n\\t\\t2018-01-03T08:57Z\\r\\n\\t\\t1527690629357\\r\\n\\t\\t2.2.2.2\\r\\n\\t\\t1\\r\\n\\t\\tSMART\\r\\n\\t\\tOK\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '获取地址池详细信息(旧版)',
'summary' => '获取地址池详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmInstanceAddressPools' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => 'GTM实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtmtest',
],
],
[
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'AddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddrPool' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '地址池类型:'."\n"
."\n"
.'- **IP**:IP地址'."\n"
.'- **DOMAIN**:域名',
'type' => 'string',
'example' => 'IP',
],
'Status' => [
'description' => '地址池可用状态:'."\n"
."\n"
.'- **AVAILABLE**:可用'."\n"
.'- **NOT_AVAILABLE**:不可用',
'type' => 'string',
'example' => 'AVAILABLE',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'MonitorConfigId' => [
'description' => '监控配置ID。',
'type' => 'string',
'example' => '100abc',
],
'MinAvailableAddrNum' => [
'description' => '最小可用地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'MonitorStatus' => [
'description' => '监控状态。其中:'."\n"
."\n"
.'- **OPEN**:开启'."\n"
.'- **CLOSE**:关闭'."\n"
.'- **UNCONFIGURED**:未配置',
'type' => 'string',
'example' => 'OPEN',
],
'AddrPoolId' => [
'description' => '地址池ID。',
'type' => 'string',
'example' => 'hrbpnf',
],
'Name' => [
'description' => '地址池名称。',
'type' => 'string',
'example' => 'test',
],
'AddrCount' => [
'description' => '地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 2,\\n \\"AddrPools\\": {\\n \\"AddrPool\\": [\\n {\\n \\"Type\\": \\"IP\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"UpdateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"CreateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"MonitorConfigId\\": \\"100abc\\",\\n \\"MinAvailableAddrNum\\": 2,\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"MonitorStatus\\": \\"OPEN\\",\\n \\"AddrPoolId\\": \\"hrbpnf\\",\\n \\"Name\\": \\"test\\",\\n \\"AddrCount\\": 2,\\n \\"CreateTimestamp\\": 1527690629357\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n1\\r\\n\\t20\\r\\n\\t6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n\\t2\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t1234abc\\r\\n\\t\\t2017-12-28T13:08Z\\r\\n\\t\\t1527690629357\\r\\n\\t\\t2\\r\\n\\t\\t2\\r\\n\\t\\t100abc\\r\\n\\t\\tOPEN\\r\\n\\t\\t名称测试1\\r\\n\\t\\tAVAILABLE\\r\\n\\t\\tIP\\r\\n\\t\\t2018-01-03T08:57Z\\r\\n\\t\\t1527690629357\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t2345abc\\r\\n\\t\\t2017-12-28T13:08Z\\r\\n\\t\\t1527690629357\\r\\n\\t\\t2\\r\\n\\t\\t2\\r\\n\\t\\t101abc\\r\\n\\t\\tOPEN\\r\\n\\t\\t名称测试2\\r\\n\\t\\tAVAILABLE\\r\\n\\t\\tIP\\r\\n\\t\\t2018-01-03T08:57Z\\r\\n\\t\\t1527690629357\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '获取GTM实例地址池列表(旧版)',
'summary' => '获取GTM实例地址池列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddDnsGtmMonitor' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'AddrPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池id。可通过调用[DescribeDnsGtmInstanceAddressPools ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspools?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_9_7.1cee430dbd1I3y)获取'."\n"
.'可通过调用[DescribeDnsGtmInstanceAddressPools ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspools?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'po**',
],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '检查协议:'."\n"
."\n"
.'- HTTP'."\n"
.'- HTTPS'."\n"
.'- PING'."\n"
.'- TCP',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'TCP',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '检查间隔,单位秒。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '60',
'minimum' => '15',
'example' => '60',
],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => [
'description' => '连续次数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '3',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => [
'description' => '超时时间,单位毫秒。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '10000',
'minimum' => '1000',
'example' => '3000',
],
],
[
'name' => 'MonitorExtendInfo',
'in' => 'query',
'schema' => [
'description' => '扩展信息,各协议检查所需参数:'."\n"
."\n"
.'- HTTP(S):'."\n"
."\n"
.' - port:检查端口'."\n"
.' - host:Host设置'."\n"
.' - path:URL路径'."\n"
.' - code:返回码大于某个数值时则判定健康检查异常。'."\n"
.' - failureRate:失败率'."\n"
.' - sni:是否开启sni,仅在HTTPS协议时使用。'."\n"
.' - true-开启'."\n"
.' - false-未开启'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
."\n"
.'- PING:'."\n"
."\n"
.' - failureRate:失败率'."\n"
.' - packetNum:ping包数'."\n"
.' - packetLossRate:ping丢包率'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
."\n"
.'- TCP:'."\n"
."\n"
.' - port:检查端口'."\n"
.' - failureRate:失败率'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
.'> 本字段需以 JSON 字符串格式输入。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [],
'example' => '{"failureRate":50,"port":80}',
],
],
[
'name' => 'IspCityNode',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '监控城市节点列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '监控节点-城市code。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => '123',
],
'IspCode' => [
'description' => '监控节点-运营商code。',
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'MonitorConfigId' => [
'description' => '健康检查配置id。'."\n"
."\n",
'type' => 'string',
'example' => 'Mon*******',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"MonitorConfigId\\": \\"Mon*******\\"\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B\\nMonitorConfigId1","errorExample":""}]',
'title' => '添加健康检查',
'summary' => '创建健康检查。',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddGtmMonitor' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'AddrPoolId',
'in' => 'query',
'schema' => [
'description' => '地址池ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'xxxx',
],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '检查协议。取值:'."\n"
."\n"
.'- HTTP'."\n"
.'- HTTPS'."\n"
.'- PING'."\n"
.'- TCP',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'HTTP',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '检查间隔,单位:秒,取值范围:60。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '60',
],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => [
'description' => '连续失败次数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '3',
],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => [
'description' => '超时时间,单位:毫秒,取值范围:2000、3000、5000、10000。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '3000',
],
],
[
'name' => 'MonitorExtendInfo',
'in' => 'query',
'schema' => [
'description' => '扩展信息。根据不同协议,进行传参:'."\n"
."\n"
.'HTTP、HTTPS:'."\n"
."\n"
.'- port:检查端口'."\n"
.'- failureRate:失败比例'."\n"
.'- code:返回码(大于此值会被判定为异常)。取值:400、500。'."\n"
.'- host:Host设置'."\n"
.'- path:URL路径'."\n"
."\n"
.'PING:'."\n"
."\n"
.'- packetNum:ping包数'."\n"
.'- packetLossRate:丢包率'."\n"
.'- failureRate:失败比例'."\n"
."\n"
.'TCP:'."\n"
."\n"
.'- port:检查端口'."\n"
.'- failureRate:失败比例',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{\\"code\\":200,\\"path\\":\\"/index.htm\\",\\"host\\":\\"aliyun.com\\"}',
],
],
[
'name' => 'IspCityNode',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '监控城市节点列表。',
'type' => 'array',
'items' => [
'description' => '监控城市节点。',
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市Code。'."\n"
."\n"
.'具体取值可参考:DescribeGtmMonitorAvailableConfig接口返回数据。',
'type' => 'string',
'required' => false,
'example' => '503',
],
'IspCode' => [
'description' => '具体取值可参考:DescribeGtmMonitorAvailableConfig接口返回数据。'."\n"
."\n"
.'- GroupType为BGP或Overseas时,IspCityNode.N.IspCode为非必传值,默认为465。'."\n"
.'- GroupType为非BGP或Overseas时,IspCityNode.N.IspCode为必传值。并与IspCityNode.N.CityCode匹配使用。',
'type' => 'string',
'required' => false,
'example' => '465',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'MonitorConfigId' => [
'description' => '健康检查配置ID',
'type' => 'string',
'example' => '1234abc',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"MonitorConfigId\\": \\"1234abc\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n\\t1234abc\\r\\n","errorExample":""}]',
'title' => '添加健康检查(旧版)',
'summary' => '创建健康检查。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDnsGtmMonitor' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'MonitorConfigId',
'in' => 'query',
'schema' => [
'description' => '健康检查配置id。可通过调用[DescribeDnsGtmInstanceAddressPool](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspool?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_9_6.7db77000nMCPI1)获取'."\n"
.'可通过调用[DescribeDnsGtmInstanceAddressPool](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspool?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Monito******',
],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '检查协议:'."\n"
."\n"
.'- HTTP'."\n"
.'- HTTPS'."\n"
.'- PING'."\n"
.'- TCP',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'http',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '检查间隔,单位秒。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '60',
'minimum' => '15',
'example' => '60',
],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => [
'description' => '连续次数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '3',
'minimum' => '1',
'example' => '2',
],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => [
'description' => '超时时间,单位毫秒。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '10000',
'minimum' => '1000',
'example' => '3000',
],
],
[
'name' => 'MonitorExtendInfo',
'in' => 'query',
'schema' => [
'description' => '扩展信息,各协议检查所需参数:'."\n"
."\n"
.'- HTTP(S):'."\n"
."\n"
.' - port:检查端口'."\n"
.' - host:Host设置'."\n"
.' - path:URL路径'."\n"
.' - code:返回码大于设定值时则认为健康检查异常,例如设置为400,当返回码为404时,判定健康检查结果异常。'."\n"
.' - failureRate:失败率'."\n"
.' - sni:是否开启sni,仅在HTTPS协议时使用。'."\n"
.' - true-开启'."\n"
.' - false-未开启'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
."\n"
.'- PING:'."\n"
."\n"
.' - failureRate:失败率'."\n"
.' - packetNum:ping包数'."\n"
.' - packetLossRate:ping丢包率'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
."\n"
.'- TCP:'."\n"
."\n"
.' - port:检查端口'."\n"
.' - failureRate:失败率'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}',
],
],
[
'name' => 'IspCityNode',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '监控城市节点列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '监控节点-城市Code。',
'type' => 'string',
'required' => false,
'example' => '123',
],
'IspCode' => [
'description' => '监控节点-运营商code。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => '123',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 50,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B","errorExample":""}]',
'title' => '修改健康检查',
'summary' => '修改健康检查。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateGtmMonitor' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '用户语言',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'MonitorConfigId',
'in' => 'query',
'schema' => [
'description' => '健康检查配置ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '1234abc',
],
],
[
'name' => 'ProtocolType',
'in' => 'query',
'schema' => [
'description' => '检查协议',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'HTTP',
],
],
[
'name' => 'Interval',
'in' => 'query',
'schema' => [
'description' => '检查间隔,单位:秒,取值范围:60。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
[
'name' => 'EvaluationCount',
'in' => 'query',
'schema' => [
'description' => '连续次数',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
],
],
[
'name' => 'Timeout',
'in' => 'query',
'schema' => [
'description' => '超时时间,单位:毫秒,取值范围:2000、3000、5000、10000。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3000',
],
],
[
'name' => 'MonitorExtendInfo',
'in' => 'query',
'schema' => [
'description' => '扩展信息。根据不同协议,进行传参:'."\n"
."\n"
.'HTTP、HTTPS:'."\n"
."\n"
.'- port:检查端口'."\n"
.'- failureRate:失败率'."\n"
.'- code:返回码(大于此值会被判定为异常)。取值:400、500。'."\n"
.'- host:Host设置'."\n"
.'- path:URL路径'."\n"
."\n"
.'PING:'."\n"
."\n"
.'- packetNum:ping包数'."\n"
.'- packetLossRate:ping丢包率'."\n"
.'- failureRate:失败率'."\n"
."\n"
.'TCP:'."\n"
."\n"
.'- port:检查端口'."\n"
.'- failureRate:失败率',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '{\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}',
],
],
[
'name' => 'IspCityNode',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '监控城市节点列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市Code',
'type' => 'string',
'required' => false,
'example' => '572',
],
'IspCode' => [
'description' => '- 具体取值可参考:DescribeGtmMonitorAvailableConfig接口返回数据。'."\n"
.'- GroupType为BGP或Overseas时,IspCityNode.N.IspCode为非必传值,默认为465。'."\n"
.'- GroupType为非BGP或Overseas时,IspCityNode.N.IspCode为必传值。并与IspCityNode.N.CityCode匹配使用。',
'type' => 'string',
'required' => false,
'example' => '465',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 20,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n","errorExample":""}]',
'title' => '修改健康检查(旧版)',
'summary' => '修改健康检查。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDnsGtmMonitorStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'MonitorConfigId',
'in' => 'query',
'schema' => [
'description' => '健康检查配置id。可通过调用[DescribeDnsGtmInstanceAddressPool](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspool?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_9_6.7db77000nMCPI1)获取'."\n"
.'可通过调用[DescribeDnsGtmInstanceAddressPool](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspool?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Monito*****',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '开启状态:'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭'."\n"
."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'OPEN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B","errorExample":""}]',
'title' => '设置 DNS 地址池健康检查状态',
'summary' => '设置地址池健康检查状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetGtmMonitorStatus' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'MonitorConfigId',
'in' => 'query',
'schema' => [
'description' => '健康检查配置ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'abc1234',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '开启状态。取值:'."\n"
."\n"
.'- **OPEN**:开启'."\n"
.'- **CLOSE**:关闭',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'OPEN',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n","errorExample":""}]',
'title' => '设置地址池健康检查状态(旧版)',
'summary' => '设置地址池健康检查状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmMonitorAvailableConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IspCityNode' => [
'description' => '监控节点列表。',
'type' => 'array',
'items' => [
'description' => '监控节点。',
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市编码。',
'type' => 'string',
'example' => '503',
],
'Mainland' => [
'description' => '是否是中国内地。',
'type' => 'boolean',
'example' => 'true',
],
'GroupName' => [
'description' => '节点分组名称。',
'type' => 'string',
'example' => '国际节点',
],
'IspCode' => [
'description' => '运营商编码'."\n"
."\n"
.'- GroupType为BGP或Overseas时,IspCode为非必传值,默认为465。'."\n"
.'- GroupType为非BGP或Overseas时,IspCode为必传值。并与CityCode匹配使用。',
'type' => 'string',
'example' => '465',
],
'CityName' => [
'description' => '城市展示名。',
'type' => 'string',
'example' => '张家口市',
],
'IspName' => [
'description' => '运营商展示名(目前仅阿里巴巴)。',
'type' => 'string',
'example' => '阿里巴巴',
],
'GroupType' => [
'description' => '节点分组类型:当前支持'."\n"
.'BGP:BGP节点;'."\n"
.'OVERSEAS:国际节点;'."\n"
.'ISP:运营商节点。',
'type' => 'string',
'example' => 'OVERSEAS',
],
'DefaultSelected' => [
'description' => '是否默认选中。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"IspCityNodes\\": {\\n \\"IspCityNode\\": [\\n {\\n \\"CityCode\\": \\"503\\",\\n \\"Mainland\\": true,\\n \\"GroupName\\": \\"国际节点\\",\\n \\"IspCode\\": \\"465\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"GroupType\\": \\"OVERSEAS\\",\\n \\"DefaultSelected\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n\\t\\r\\n\\t\\t阿里巴巴\\r\\n\\t\\t465\\r\\n\\t\\t张家口市\\r\\n\\t\\t503\\r\\n\\t\\ttrue\\r\\n\\t\\ttrue\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t阿里巴巴\\r\\n\\t\\t465\\r\\n\\t\\t青岛市\\r\\n\\t\\t572\\r\\n\\t\\tfalse\\r\\n\\t\\ttrue\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '获取健康检查可设置的配置(旧版)',
'summary' => '获取健康检查可设置的配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmMonitorConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'MonitorConfigId',
'in' => 'query',
'schema' => [
'description' => '健康检查配置ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '100',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'Timeout' => [
'description' => '超时时间,单位:毫秒,取值范围:2000、3000、5000、10000。',
'type' => 'integer',
'format' => 'int32',
'example' => '3000',
],
'ProtocolType' => [
'description' => '检查协议。',
'type' => 'string',
'example' => 'HTTP',
],
'IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IspCityNode' => [
'description' => '监控节点列表。',
'type' => 'array',
'items' => [
'description' => '监控节点。',
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市编码。',
'type' => 'string',
'example' => '503',
],
'CountryName' => [
'description' => '国家展示名。',
'type' => 'string',
'example' => '中国',
],
'IspCode' => [
'description' => '运营商Code。',
'type' => 'string',
'example' => '465',
],
'CityName' => [
'description' => '城市展示名。',
'type' => 'string',
'example' => '张家口市',
],
'CountryCode' => [
'description' => '国家编码。',
'type' => 'string',
'example' => '001',
],
'IspName' => [
'description' => '运营商名称。',
'type' => 'string',
'example' => '阿里巴巴',
],
],
],
],
],
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'EvaluationCount' => [
'description' => '连续次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'MonitorExtendInfo' => [
'description' => '扩展信息。根据不同协议,进行传参:'."\n"
."\n"
.'HTTP、HTTPS:'."\n"
."\n"
.'- port:检查端口'."\n"
.'- failureRate:失败率'."\n"
.'- code:返回码(大于此值会被判定为异常)。取值:400、500。'."\n"
.'- host:Host设置'."\n"
.'- path:URL路径'."\n"
."\n"
.'PING:'."\n"
."\n"
.'- packetNum:ping包数'."\n"
.'- packetLossRate:ping丢包率'."\n"
.'- failureRate:失败率'."\n"
."\n"
.'TCP:'."\n"
."\n"
.'- port:检查端口'."\n"
.'- failureRate:失败率',
'type' => 'string',
'example' => '{\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}',
],
'MonitorConfigId' => [
'description' => '健康检查配置ID。',
'type' => 'string',
'example' => '1234abc',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'Interval' => [
'description' => '检查间隔,单位:秒,取值范围:60。',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"Timeout\\": 3000,\\n \\"ProtocolType\\": \\"HTTP\\",\\n \\"IspCityNodes\\": {\\n \\"IspCityNode\\": [\\n {\\n \\"CityCode\\": \\"503\\",\\n \\"CountryName\\": \\"中国\\",\\n \\"IspCode\\": \\"465\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"CountryCode\\": \\"001\\",\\n \\"IspName\\": \\"阿里巴巴\\"\\n }\\n ]\\n },\\n \\"CreateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"UpdateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"EvaluationCount\\": 3,\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"MonitorExtendInfo\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\index.htm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aliyun.com\\\\\\\\\\\\\\"}\\",\\n \\"MonitorConfigId\\": \\"1234abc\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"Interval\\": 60\\n}","errorExample":""},{"type":"xml","example":"\\r\\n6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n\\t1234abc\\r\\n\\t2017-12-28T13:08Z\\r\\n\\t1527690629357\\r\\n\\t2018-01-03T08:57Z\\r\\n\\t1527690629357\\r\\n\\tHTTP\\r\\n\\t60\\r\\n\\t3\\r\\n\\t3000\\r\\n\\t{"code":200,"path":"\\\\index.htm","host":"aliyun.com"}\\r\\n\\t\\r\\n\\t\\t中国\\r\\n\\t\\t001\\r\\n\\t\\t张家口市\\r\\n\\t\\t503\\r\\n\\t\\r\\n\\t\\r\\n\\t\\t中国\\r\\n\\t\\t001\\r\\n\\t\\t青岛市\\r\\n\\t\\t572\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '获取地址池健康检查配置(旧版)',
'summary' => '获取地址池健康检查配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmMonitorAvailableConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Ipv4IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ipv4IspCityNode' => [
'description' => '公网Ipv4监控节点列表。',
'type' => 'array',
'items' => [
'description' => '公网ipv4监控节点。',
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市编码。'."\n"
."\n",
'type' => 'string',
'example' => '503',
],
'GroupName' => [
'description' => '节点分组名称。'."\n"
."\n",
'type' => 'string',
'example' => 'BGP节点',
],
'IspCode' => [
'description' => '运营商编码。'."\n"
."\n",
'type' => 'string',
'example' => '465',
],
'CityName' => [
'description' => '城市展示名。'."\n"
."\n",
'type' => 'string',
'example' => '张家口市',
],
'IspName' => [
'description' => '运营商展示名。'."\n"
."\n",
'type' => 'string',
'example' => '阿里巴巴',
],
'GroupType' => [
'description' => '节点分组类型,当前支持:'."\n"
."\n"
.'- BGP:BGP节点'."\n"
.'- OVERSEAS:国际节点'."\n"
.'- ISP:运营商节点',
'type' => 'string',
'example' => 'BGP',
],
'DefaultSelected' => [
'description' => '是否默认选中。',
'type' => 'boolean',
'example' => 'true',
],
'Ips' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ip' => [
'description' => '节点ip列表。',
'type' => 'array',
'items' => [
'description' => '节点IP列表。',
'type' => 'string',
'example' => '['."\n"
.' "1.1.XX.XX",'."\n"
.' "2.2.XX.XX"'."\n"
.']',
],
],
],
],
],
],
],
],
],
'DomainIpv4IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainIpv4IspCityNode' => [
'description' => '公网域名Ipv4监控节点列表。',
'type' => 'array',
'items' => [
'description' => '公网域名Ipv4监控节点。',
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市编码。',
'type' => 'string',
'example' => '503',
],
'GroupName' => [
'description' => '节点分组名称。',
'type' => 'string',
'example' => 'BGP节点',
],
'IspCode' => [
'description' => '运营商编码。',
'type' => 'string',
'example' => '465',
],
'CityName' => [
'description' => '城市展示名。',
'type' => 'string',
'example' => '张家口市',
],
'IspName' => [
'description' => '运营商展示名。',
'type' => 'string',
'example' => '阿里巴巴',
],
'GroupType' => [
'description' => '节点分组类型,当前支持:'."\n"
."\n"
.'- BGP:BGP节点'."\n"
.'- OVERSEAS:国际节点'."\n"
.'- ISP:运营商节点',
'type' => 'string',
'example' => 'BGP',
],
'DefaultSelected' => [
'description' => '是否默认选中。',
'type' => 'boolean',
'example' => 'true',
],
'Ips' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ip' => [
'description' => '节点ip列表。',
'type' => 'array',
'items' => [
'description' => '节点IP。',
'type' => 'string',
'example' => '['."\n"
.' "1.1.XX.XX",'."\n"
.' "2.2.XX.XX"'."\n"
.']',
],
],
],
],
],
],
],
],
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'DomainIpv6IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainIpv6IspCityNode' => [
'description' => '公网域名Ipv6监控节点列表。',
'type' => 'array',
'items' => [
'description' => '公网域名ipv6监控节点。',
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市编码。',
'type' => 'string',
'example' => '503',
],
'GroupName' => [
'description' => '节点分组名称。',
'type' => 'string',
'example' => 'BGP节点',
],
'IspCode' => [
'description' => '运营商编码。',
'type' => 'string',
'example' => '465',
],
'CityName' => [
'description' => '城市展示名。',
'type' => 'string',
'example' => '张家口市',
],
'IspName' => [
'description' => '运营商展示名。',
'type' => 'string',
'example' => '阿里巴巴',
],
'GroupType' => [
'description' => '节点分组类型,当前支持:'."\n"
."\n"
.'- BGP:BGP节点'."\n"
.'- OVERSEAS:国际节点'."\n"
.'- ISP:运营商节点',
'type' => 'string',
'example' => 'BGP',
],
'DefaultSelected' => [
'description' => '是否默认选中。',
'type' => 'boolean',
'example' => 'false',
],
'Ips' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ip' => [
'description' => '暂不开放此返回参数。',
'type' => 'array',
'items' => [
'description' => '暂不开放此返回参数。',
'type' => 'string',
'example' => '暂无',
],
],
],
],
],
],
],
],
],
'Ipv6IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ipv6IspCityNode' => [
'description' => '公网Ipv6监控节点列表。',
'type' => 'array',
'items' => [
'description' => '公网Ipv6监控节点。'."\n"
."\n",
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市编码。'."\n"
."\n",
'type' => 'string',
'example' => '503',
],
'GroupName' => [
'description' => '节点分组名称。'."\n"
."\n",
'type' => 'string',
'example' => 'BGP节点',
],
'IspCode' => [
'description' => '运营商编码。'."\n"
."\n",
'type' => 'string',
'example' => '465',
],
'CityName' => [
'description' => '城市展示名。'."\n"
."\n",
'type' => 'string',
'example' => '张家口市',
],
'IspName' => [
'description' => '运营商展示名。'."\n"
."\n",
'type' => 'string',
'example' => '阿里巴巴',
],
'GroupType' => [
'description' => '节点分组类型,当前支持:'."\n"
."\n"
.'- BGP:BGP节点'."\n"
.'- OVERSEAS:国际节点'."\n"
.'- ISP:运营商节点',
'type' => 'string',
'example' => 'BGP',
],
'DefaultSelected' => [
'description' => '是否默认选中。'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
'Ips' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ip' => [
'description' => '暂不开放此返回参数。',
'type' => 'array',
'items' => [
'description' => '暂不开放此返回参数。',
'type' => 'string',
'example' => '暂无',
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Ipv4IspCityNodes\\": {\\n \\"Ipv4IspCityNode\\": [\\n {\\n \\"CityCode\\": \\"503\\",\\n \\"GroupName\\": \\"BGP节点\\",\\n \\"IspCode\\": \\"465\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"GroupType\\": \\"BGP\\",\\n \\"DefaultSelected\\": true,\\n \\"Ips\\": {\\n \\"Ip\\": [\\n \\"[\\\\n \\\\\\"1.1.XX.XX\\\\\\",\\\\n \\\\\\"2.2.XX.XX\\\\\\"\\\\n]\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"DomainIpv4IspCityNodes\\": {\\n \\"DomainIpv4IspCityNode\\": [\\n {\\n \\"CityCode\\": \\"503\\",\\n \\"GroupName\\": \\"BGP节点\\",\\n \\"IspCode\\": \\"465\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"GroupType\\": \\"BGP\\",\\n \\"DefaultSelected\\": true,\\n \\"Ips\\": {\\n \\"Ip\\": [\\n \\"[\\\\n \\\\\\"1.1.XX.XX\\\\\\",\\\\n \\\\\\"2.2.XX.XX\\\\\\"\\\\n]\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"DomainIpv6IspCityNodes\\": {\\n \\"DomainIpv6IspCityNode\\": [\\n {\\n \\"CityCode\\": \\"503\\",\\n \\"GroupName\\": \\"BGP节点\\",\\n \\"IspCode\\": \\"465\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"GroupType\\": \\"BGP\\",\\n \\"DefaultSelected\\": false,\\n \\"Ips\\": {\\n \\"ip\\": [\\n \\"暂无\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"Ipv6IspCityNodes\\": {\\n \\"Ipv6IspCityNode\\": [\\n {\\n \\"CityCode\\": \\"503\\",\\n \\"GroupName\\": \\"BGP节点\\",\\n \\"IspCode\\": \\"465\\",\\n \\"CityName\\": \\"张家口市\\",\\n \\"IspName\\": \\"阿里巴巴\\",\\n \\"GroupType\\": \\"BGP\\",\\n \\"DefaultSelected\\": true,\\n \\"Ips\\": {\\n \\"Ip\\": [\\n \\"暂无\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 503\\n BGP节点\\n 阿里巴巴\\n BGP\\n 张家口市\\n 465\\n true\\n \\n 1.1.1.1\\n 2.2.2.2\\n \\n \\n\\n\\n \\n 503\\n BGP节点\\n 阿里巴巴\\n BGP\\n 张家口市\\n 465\\n true\\n \\n 1.1.1.1\\n 2.2.2.2\\n \\n \\n\\n6856BCF6-11D6-4D7E-AC53-FD579933522B\\n\\n \\n 503\\n BGP节点\\n 阿里巴巴\\n BGP\\n 张家口市\\n 465\\n false\\n \\n\\n\\n \\n 503\\n BGP节点\\n 阿里巴巴\\n BGP\\n 张家口市\\n 465\\n true\\n \\n","errorExample":""}]',
'title' => '获取 DNS 健康检查可设置的配置',
'summary' => '获取 DNS 健康检查可设置的配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmMonitorConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'MonitorConfigId',
'in' => 'query',
'schema' => [
'description' => '健康检查配置id。可通过调用[DescribeDnsGtmInstanceAddressPool](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspool?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_9_6.7db77000nMCPI1)获取'."\n"
.'可通过调用[DescribeDnsGtmInstanceAddressPool](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstanceaddresspool?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'Moni*******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'Timeout' => [
'description' => '超时时间。单位毫秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '3000',
],
'ProtocolType' => [
'description' => '检查协议:'."\n"
."\n"
.'- HTTP'."\n"
.'- HTTPS'."\n"
.'- PING'."\n"
.'- TCP',
'type' => 'string',
'example' => 'TCP',
],
'IspCityNodes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'IspCityNode' => [
'description' => '监控节点列表。',
'type' => 'array',
'items' => [
'description' => '监控节点。',
'type' => 'object',
'properties' => [
'CityCode' => [
'description' => '城市编码。',
'type' => 'string',
'example' => '572',
],
'CountryName' => [
'description' => '国家展示名。'."\n"
."\n",
'type' => 'string',
'example' => '中国',
],
'IspCode' => [
'description' => '运营商编码。'."\n"
."\n",
'type' => 'string',
'example' => '123',
],
'CityName' => [
'description' => '城市展示名。'."\n"
."\n",
'type' => 'string',
'example' => '青岛市',
],
'CountryCode' => [
'description' => '国家编码。'."\n"
."\n",
'type' => 'string',
'example' => '001',
],
'IspName' => [
'description' => '运营商名称。'."\n"
."\n",
'type' => 'string',
'example' => '阿里巴巴',
],
],
],
],
],
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2017-12-28T13:08Z',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2018-01-03T08:57Z',
],
'EvaluationCount' => [
'description' => '连续失败次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'MonitorExtendInfo' => [
'description' => '扩展信息,各协议检查所需参数:'."\n"
."\n"
.'- HTTP(S):'."\n"
."\n"
.' - port:检查端口'."\n"
.' - host:Host设置'."\n"
.' - path:URL路径'."\n"
.' - code:返回码大于'."\n"
.' - failureRate:失败率'."\n"
.' - sni:是否开启sni,仅在HTTPS协议时使用。'."\n"
.' - true-开启'."\n"
.' - false-未开启'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
."\n"
.'- PING:'."\n"
."\n"
.' - failureRate:失败率'."\n"
.' - packetNum:ping包数'."\n"
.' - packetLossRate:ping丢包率'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
."\n"
.'- TCP:'."\n"
."\n"
.' - port:检查端口'."\n"
.' - failureRate:失败率'."\n"
.' - nodeType:地址池类型为DOMAIN时,健康检查监控节点类型:'."\n"
.' - IPV4'."\n"
.' - IPV6'."\n"
."\n",
'type' => 'string',
'example' => '{\\"code\\":200,\\"path\\":\\"\\\\index.htm\\",\\"host\\":\\"aliyun.com\\"}',
],
'MonitorConfigId' => [
'description' => '健康检查配置id。'."\n"
."\n",
'type' => 'string',
'example' => 'Monit*********',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'Interval' => [
'description' => '检查间隔,单位秒。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"Timeout\\": 3000,\\n \\"ProtocolType\\": \\"TCP\\",\\n \\"IspCityNodes\\": {\\n \\"IspCityNode\\": [\\n {\\n \\"CityCode\\": \\"572\\",\\n \\"CountryName\\": \\"中国\\",\\n \\"IspCode\\": \\"123\\",\\n \\"CityName\\": \\"青岛市\\",\\n \\"CountryCode\\": \\"001\\",\\n \\"IspName\\": \\"阿里巴巴\\"\\n }\\n ]\\n },\\n \\"CreateTime\\": \\"2017-12-28T13:08Z\\",\\n \\"UpdateTime\\": \\"2018-01-03T08:57Z\\",\\n \\"EvaluationCount\\": 3,\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"MonitorExtendInfo\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\"path\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\index.htm\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"host\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"aliyun.com\\\\\\\\\\\\\\"}\\",\\n \\"MonitorConfigId\\": \\"Monit*********\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"Interval\\": 1\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B\\n3000\\nhttp\\n\\n \\n 572\\n 阿里巴巴\\n 中国\\n 青岛市\\n 001\\n 123\\n \\n\\n2017-12-28T13:08Z\\n2018-01-03T08:57Z\\n1\\n\\"{\\\\\\"code\\\\\\":200,\\\\\\"path\\\\\\":\\\\\\"\\\\\\\\index.htm\\\\\\",\\\\\\"host\\\\\\":\\\\\\"aliyun.com\\\\\\"}\\"\\n1527690629357\\nMonitorConfigId1\\n1527690629357\\n1","errorExample":""}]',
'title' => '获取 DNS 地址池健康检查配置',
'summary' => '获取地址池健康检查配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddDnsGtmAccessStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'instance1',
],
],
[
'name' => 'StrategyName',
'in' => 'query',
'schema' => [
'description' => '策略名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testStrategyName',
],
],
[
'name' => 'Lines',
'in' => 'query',
'schema' => [
'description' => '解析请求来源。例如:`["default", "drpeng"]`,即全局策略和鹏博士。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '["default", "drpeng"]',
],
],
[
'name' => 'DefaultAddrPoolType',
'in' => 'query',
'schema' => [
'description' => '主地址池类型:'."\n"
."\n"
.'- IPV4'."\n"
.'- IPV6'."\n"
.'- DOMAIN',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'IPV4',
],
],
[
'name' => 'DefaultLbaStrategy',
'in' => 'query',
'schema' => [
'description' => '主地址池集合负载均衡策略:'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'required' => false,
'example' => 'ALL_RR',
],
],
[
'name' => 'DefaultMinAvailableAddrNum',
'in' => 'query',
'schema' => [
'description' => '主地址池集合最小可用地址数量。'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '400',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'DefaultMaxReturnAddrNum',
'in' => 'query',
'schema' => [
'description' => '主地址池集合最多返回地址数量。'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '8',
'minimum' => '1',
'example' => '3',
],
],
[
'name' => 'DefaultLatencyOptimization',
'in' => 'query',
'schema' => [
'description' => '主地址池集合延时解析调度优化:'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭',
'type' => 'string',
'required' => false,
'example' => 'OPEN',
],
],
[
'name' => 'FailoverAddrPoolType',
'in' => 'query',
'schema' => [
'description' => '备地址池类型:'."\n"
."\n"
.'- IPV4'."\n"
.'- IPV6'."\n"
.'- DOMAIN',
'type' => 'string',
'required' => false,
'example' => 'IPV4',
],
],
[
'name' => 'FailoverLbaStrategy',
'in' => 'query',
'schema' => [
'description' => '备地址池集合负载均衡策略:'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'required' => false,
'example' => 'ALL_RR',
],
],
[
'name' => 'FailoverMinAvailableAddrNum',
'in' => 'query',
'schema' => [
'description' => '备地址池集合最小可用地址数量。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '400',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'FailoverMaxReturnAddrNum',
'in' => 'query',
'schema' => [
'description' => '备地址池集合最多返回地址数量。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '8',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'FailoverLatencyOptimization',
'in' => 'query',
'schema' => [
'description' => '备地址池集合延时解析调度优化:'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭',
'type' => 'string',
'required' => false,
'example' => 'OPEN',
],
],
[
'name' => 'StrategyMode',
'in' => 'query',
'schema' => [
'description' => '访问策略类型:'."\n"
."\n"
.'- GEO:基于地理位置的访问策略'."\n"
.'- LATENCY:基于访问延时的访问策略',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'GEO',
],
],
[
'name' => 'DefaultAddrPool',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '主地址池集合列表。',
'type' => 'array',
'items' => [
'description' => '主地址池集合。',
'type' => 'object',
'properties' => [
'LbaWeight' => [
'description' => '主地址池集合列表中权重。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Id' => [
'description' => '主地址池集合列表中地址池Id。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => 'pool1',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 100,
],
],
[
'name' => 'FailoverAddrPool',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '备地址池集合,若未设置备地址池集合,输入"EMPTY"。',
'type' => 'array',
'items' => [
'description' => '备地址池集合。',
'type' => 'object',
'properties' => [
'LbaWeight' => [
'description' => '备地址池集合列表中权重。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'Id' => [
'description' => '备地址池集合列表中地址池id。',
'type' => 'string',
'required' => false,
'example' => 'pool1',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
'StrategyId' => [
'description' => '访问策略id。',
'type' => 'string',
'example' => 'testStrategyId1',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DnsGtmSystemBusyness',
'errorMessage' => ' ',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\",\\n \\"StrategyId\\": \\"testStrategyId1\\"\\n}","errorExample":""},{"type":"xml","example":"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\ntestStrategyId1","errorExample":""}]',
'title' => '新增访问策略',
'summary' => '新增访问策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddGtmAccessStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'instance1',
],
],
[
'name' => 'StrategyName',
'in' => 'query',
'schema' => [
'description' => '策略名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '访问策略测试',
],
],
[
'name' => 'DefaultAddrPoolId',
'in' => 'query',
'schema' => [
'description' => '主地址池集合ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hrsix',
],
],
[
'name' => 'FailoverAddrPoolId',
'in' => 'query',
'schema' => [
'description' => '备地址池集合ID。'."\n"
."\n"
.'若未设置备地址池集合,参数输入**EMPTY**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hrsyw',
],
],
[
'name' => 'AccessLines',
'in' => 'query',
'schema' => [
'description' => '解析请求来源。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["default", "drpeng"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
'StrategyId' => [
'description' => '策略ID。',
'type' => 'string',
'example' => 'strategyid',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\",\\n \\"StrategyId\\": \\"strategyid\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n xxxx\\r\\n\\t29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\r\\n","errorExample":""}]',
'title' => '新增访问策略(旧版)',
'summary' => '根据传入参数新增访问策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteDnsGtmAccessStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StrategyId',
'in' => 'query',
'schema' => [
'description' => '策略id。可通过调用[DescribeDnsGtmAccessStrategies](~~2357191~~)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testSt******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DnsGtmSystemBusyness',
'errorMessage' => ' ',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\"\\n}","errorExample":""},{"type":"xml","example":"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925","errorExample":""}]',
'title' => '删除访问策略',
'summary' => '通过策略ID删除访问策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteGtmAccessStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StrategyId',
'in' => 'query',
'schema' => [
'description' => '策略ID。',
'type' => 'string',
'required' => false,
'example' => 'hrskc',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求标识。',
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\r\\n","errorExample":""}]',
'title' => '删除访问策略(旧版)',
'summary' => '根据传入参数删除访问策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateGtmAccessStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StrategyId',
'in' => 'query',
'schema' => [
'description' => '策略ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hrmxc',
],
],
[
'name' => 'StrategyName',
'in' => 'query',
'schema' => [
'description' => '策略名称。',
'type' => 'string',
'required' => false,
'example' => '访问策略测试',
],
],
[
'name' => 'DefaultAddrPoolId',
'in' => 'query',
'schema' => [
'description' => '主地址池集合ID。',
'type' => 'string',
'required' => false,
'example' => 'hrsix',
],
],
[
'name' => 'FailoverAddrPoolId',
'in' => 'query',
'schema' => [
'description' => '备地址池集合ID。',
'type' => 'string',
'required' => false,
'example' => 'hrsyw',
],
],
[
'name' => 'AccessLines',
'in' => 'query',
'schema' => [
'description' => '解析请求来源。',
'type' => 'string',
'required' => false,
'example' => '["default", "mobile"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\r\\n","errorExample":""}]',
'title' => '修改访问策略(旧版)',
'summary' => '根据传入参数修改访问策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDnsGtmAccessMode' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StrategyId',
'in' => 'query',
'schema' => [
'description' => '策略Id。可通过调用[DescribeDnsGtmAccessStrategies](~~2357191~~)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hr**zb',
],
],
[
'name' => 'AccessMode',
'in' => 'query',
'schema' => [
'description' => '地址池集合切换策略:'."\n"
."\n"
.'- AUTO: 自动切换'."\n"
.'- DEFAULT:主地址池集合'."\n"
.'- FAILOVER: 备地址池集合',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'AUTO',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DnsGtmSystemBusyness',
'errorMessage' => ' ',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\"\\n}","errorExample":""},{"type":"xml","example":"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925","errorExample":""}]',
'title' => '修改生效地址池切换策略',
'summary' => '调整生效地址池访问策略。',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmAccessStrategies' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'StrategyMode',
'in' => 'query',
'schema' => [
'description' => '访问策略类型:'."\n"
."\n"
.'- GEO:基于地理位置的访问策略'."\n"
.'- LATENCY:基于访问延时的访问策略',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'GEO',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '0CCC9971-CEC9-4132-824B-4AE611C07623',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Strategies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Strategy' => [
'description' => '策略列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EffectiveLbaStrategy' => [
'description' => '当前生效地址池集合均衡策略(StrategyMode为GEO有返回值):'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'example' => 'ALL_RR',
],
'StrategyId' => [
'description' => '访问策略id。',
'type' => 'string',
'example' => 'hr***',
],
'StrategyName' => [
'description' => '访问策略名称。',
'type' => 'string',
'example' => 'strategname1',
],
'EffectiveAddrPoolGroupType' => [
'description' => '当前生效地址池集合类型:'."\n"
."\n"
.'- DEFAULT:主地址池集合'."\n"
.'- FAILOVER: 备地址池集合',
'type' => 'string',
'example' => 'DEFAULT',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2018-08-09T00:10Z',
],
'EffectiveAddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EffectiveAddrPool' => [
'description' => '当前生效地址池集合列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => '当前生效地址池集合。',
'type' => 'object',
'properties' => [
'LbaWeight' => [
'description' => '权重。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Name' => [
'description' => '地址池名称。',
'type' => 'string',
'example' => 'test',
],
'AddrCount' => [
'description' => '地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'Id' => [
'description' => '地址池id。',
'type' => 'string',
'example' => 'po***',
],
],
],
],
],
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1533773400000',
],
'EffectiveAddrPoolType' => [
'description' => '当前生效地址池类型:'."\n"
."\n"
.'- IPV4'."\n"
.'- IPV6'."\n"
.'- DOMAIN',
'type' => 'string',
'example' => 'IPV4',
],
'Lines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Line' => [
'description' => '解析请求来源列表(StrategyMode为GEO有返回值)。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '解析请求来源分组名称。',
'type' => 'string',
'example' => 'Global',
],
'LineCode' => [
'description' => '解析请求来源编码。',
'type' => 'string',
'example' => 'default',
],
'LineName' => [
'description' => '解析请求来源名称。',
'type' => 'string',
'example' => 'Global',
],
'GroupCode' => [
'description' => '解析请求来源分组编码。',
'type' => 'string',
'example' => 'DEFAULT',
],
],
],
],
],
],
],
],
],
],
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'TotalItems' => [
'description' => '总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 1,\\n \\"RequestId\\": \\"0CCC9971-CEC9-4132-824B-4AE611C07623\\",\\n \\"PageNumber\\": 1,\\n \\"Strategies\\": {\\n \\"Strategy\\": [\\n {\\n \\"EffectiveLbaStrategy\\": \\"ALL_RR\\",\\n \\"StrategyId\\": \\"hr***\\",\\n \\"StrategyName\\": \\"strategname1\\",\\n \\"EffectiveAddrPoolGroupType\\": \\"DEFAULT\\",\\n \\"CreateTime\\": \\"2018-08-09T00:10Z\\",\\n \\"EffectiveAddrPools\\": {\\n \\"EffectiveAddrPool\\": [\\n {\\n \\"LbaWeight\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"AddrCount\\": 3,\\n \\"Id\\": \\"po***\\"\\n }\\n ]\\n },\\n \\"CreateTimestamp\\": 1533773400000,\\n \\"EffectiveAddrPoolType\\": \\"IPV4\\",\\n \\"Lines\\": {\\n \\"Line\\": [\\n {\\n \\"GroupName\\": \\"Global\\",\\n \\"LineCode\\": \\"default\\",\\n \\"LineName\\": \\"Global\\",\\n \\"GroupCode\\": \\"DEFAULT\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"TotalPages\\": 11,\\n \\"TotalItems\\": 11\\n}","errorExample":""},{"type":"xml","example":"1\\n0CCC9971-CEC9-4132-824B-4AE611C07623\\n1\\n\\n \\n strategname1\\n ipv4\\n default\\n 2018-08-09T00:10Z\\n strategyid1\\n 1533773400000\\n all_rr\\n \\n \\n \\n \\n pool1\\n 1\\n 3\\n test\\n \\n \\n \\n \\n global\\n default\\n default\\n global\\n \\n \\n \\n\\n11\\n11","errorExample":""}]',
'title' => '获取实例访问策略列表',
'summary' => '通过实例ID获取实例访问策略列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmAccessStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StrategyId',
'in' => 'query',
'schema' => [
'description' => '访问策略id。可通过调用[DescribeDnsGtmAccessStrategies](~~2357191~~)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hr****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'FailoverMinAvailableAddrNum' => [
'description' => '备地址池集合最小可用地址数量。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'DefaultAddrPoolType' => [
'description' => '主地址池类型:'."\n"
."\n"
.'- IPV4'."\n"
.'- IPV6'."\n"
.'- DOMAIN',
'type' => 'string',
'example' => 'IPV4',
],
'DefaultAvailableAddrNum' => [
'description' => '主地址池当前可用地址数量。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'StrategyId' => [
'description' => '访问策略id。',
'type' => 'string',
'example' => 'hr***',
],
'FailoverAddrPoolGroupStatus' => [
'description' => '备地址池集合状态:'."\n"
."\n"
.'- AVAILABLE:可用'."\n"
.'- NOT_AVAILABLE:不可用',
'type' => 'string',
'example' => 'AVAILABLE',
],
'FailoverAvailableAddrNum' => [
'description' => '备地址池当前可用地址数量。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'FailoverLbaStrategy' => [
'description' => '备地址池集合均衡策略:'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'example' => 'ALL_RR',
],
'DefaultMaxReturnAddrNum' => [
'description' => '主地址池集合最多返回地址数量。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'StrategyMode' => [
'description' => '访问策略类型:'."\n"
."\n"
.'- GEO:基于地理位置的访问策略'."\n"
.'- LATENCY:基于访问延时的访问策略',
'type' => 'string',
'example' => 'GEO',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1533773400000',
],
'DefaultLbaStrategy' => [
'description' => '主地址池集合均衡策略:'."\n"
."\n"
.'- ALL_RR: 返回全部地址'."\n"
.'- RATIO:按权重返回地址',
'type' => 'string',
'example' => 'ALL_RR',
],
'DefaultAddrPoolGroupStatus' => [
'description' => '主地址池集合状态:'."\n"
."\n"
.'- AVAILABLE:可用'."\n"
.'- NOT_AVAILABLE:不可用',
'type' => 'string',
'example' => 'AVAILABLE',
],
'FailoverAddrPoolType' => [
'description' => '备地址池类型:'."\n"
."\n"
.'- IPV4'."\n"
.'- IPV6'."\n"
.'- DOMAIN',
'type' => 'string',
'example' => 'IPV4',
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => 'BA1608CA-834C-4E63-8682-8AF0B11ED72D',
],
'InstanceId' => [
'description' => '关联的GTM实例Id。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**',
],
'FailoverAddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailoverAddrPool' => [
'description' => '备地址池集合列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LbaWeight' => [
'description' => '权重。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Name' => [
'description' => '地址池名称。',
'type' => 'string',
'example' => 'test',
],
'AddrCount' => [
'description' => '地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Id' => [
'description' => '地址池id。',
'type' => 'string',
'example' => 'po**',
],
],
],
],
],
],
'DefaultLatencyOptimization' => [
'description' => '主地址池集合延时解析调度优化:'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭',
'type' => 'string',
'example' => 'OPEN',
],
'EffectiveAddrPoolGroupType' => [
'description' => '当前生效地址池集合类型:'."\n"
."\n"
.'- DEFAULT:主地址池集合'."\n"
.'- FAILOVER: 备地址池集合',
'type' => 'string',
'example' => 'DEFAULT',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2018-08-09T00:10Z',
],
'DefaultAddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DefaultAddrPool' => [
'description' => '主地址池集合列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'LbaWeight' => [
'description' => '权重。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Name' => [
'description' => '地址池名称。',
'type' => 'string',
'example' => 'test',
],
'AddrCount' => [
'description' => '地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Id' => [
'description' => '地址池id。',
'type' => 'string',
'example' => 'po***',
],
],
],
],
],
],
'DefaultMinAvailableAddrNum' => [
'description' => '主地址池集合最小可用地址数量。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'FailoverLatencyOptimization' => [
'description' => '备地址池集合延时解析调度优化:'."\n"
."\n"
.'- OPEN:开启'."\n"
.'- CLOSE:关闭',
'type' => 'string',
'example' => 'OPEN',
],
'StrategyName' => [
'description' => '访问策略名称。',
'type' => 'string',
'example' => 'strategyName1',
],
'FailoverMaxReturnAddrNum' => [
'description' => '备地址池集合最多返回地址数量。'."\n"
."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'AccessMode' => [
'description' => '地址池集合切换策略:'."\n"
."\n"
.'- AUTO:自动切换'."\n"
.'- DEFAULT:主地址池集合'."\n"
.'- FAILOVER: 备地址池集合',
'type' => 'string',
'example' => 'AUTO',
],
'Lines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Line' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '解析请求来源分组名称。',
'type' => 'string',
'example' => 'Global',
],
'LineCode' => [
'description' => '解析请求来源编码。',
'type' => 'string',
'example' => 'default',
],
'LineName' => [
'description' => '解析请求来源名称。',
'type' => 'string',
'example' => 'Global',
],
'GroupCode' => [
'description' => '解析请求来源分组编码。',
'type' => 'string',
'example' => 'DEFAULT',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"FailoverMinAvailableAddrNum\\": 1,\\n \\"DefaultAddrPoolType\\": \\"IPV4\\",\\n \\"DefaultAvailableAddrNum\\": 1,\\n \\"StrategyId\\": \\"hr***\\",\\n \\"FailoverAddrPoolGroupStatus\\": \\"AVAILABLE\\",\\n \\"FailoverAvailableAddrNum\\": 1,\\n \\"FailoverLbaStrategy\\": \\"ALL_RR\\",\\n \\"DefaultMaxReturnAddrNum\\": 1,\\n \\"StrategyMode\\": \\"GEO\\",\\n \\"CreateTimestamp\\": 1533773400000,\\n \\"DefaultLbaStrategy\\": \\"ALL_RR\\",\\n \\"DefaultAddrPoolGroupStatus\\": \\"AVAILABLE\\",\\n \\"FailoverAddrPoolType\\": \\"IPV4\\",\\n \\"RequestId\\": \\"BA1608CA-834C-4E63-8682-8AF0B11ED72D\\",\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3hbz**\\",\\n \\"FailoverAddrPools\\": {\\n \\"FailoverAddrPool\\": [\\n {\\n \\"LbaWeight\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"AddrCount\\": 1,\\n \\"Id\\": \\"po**\\"\\n }\\n ]\\n },\\n \\"DefaultLatencyOptimization\\": \\"OPEN\\",\\n \\"EffectiveAddrPoolGroupType\\": \\"DEFAULT\\",\\n \\"CreateTime\\": \\"2018-08-09T00:10Z\\",\\n \\"DefaultAddrPools\\": {\\n \\"DefaultAddrPool\\": [\\n {\\n \\"LbaWeight\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"AddrCount\\": 1,\\n \\"Id\\": \\"po***\\"\\n }\\n ]\\n },\\n \\"DefaultMinAvailableAddrNum\\": 1,\\n \\"FailoverLatencyOptimization\\": \\"OPEN\\",\\n \\"StrategyName\\": \\"strategyName1\\",\\n \\"FailoverMaxReturnAddrNum\\": 1,\\n \\"AccessMode\\": \\"AUTO\\",\\n \\"Lines\\": {\\n \\"Line\\": [\\n {\\n \\"GroupName\\": \\"Global\\",\\n \\"LineCode\\": \\"default\\",\\n \\"LineName\\": \\"Global\\",\\n \\"GroupCode\\": \\"DEFAULT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"1\\nipv4\\n1\\nAVAILABLE\\nstrategyId1\\n1\\nall_rr\\n1\\ngeo\\n1533773400000\\nAVAILABLE\\nall_rr\\nipv4\\nBA1608CA-834C-4E63-8682-8AF0B11ED72D\\ninstance1\\n\\n \\n pool1\\n 1\\n 1\\n test\\n \\n\\nopen\\n2018-08-09T00:10Z\\nDEFAULT\\n\\n \\n pool1\\n 1\\n 1\\n test\\n \\n\\n1\\nopen\\nstrategyName1\\n1\\nauto\\n\\n \\n global\\n default\\n default\\n global\\n \\n","errorExample":""}]',
'title' => '获取访问策略详细信息',
'summary' => '通过访问策略ID获取访问策略详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDnsGtmAccessStrategyAvailableConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
[
'name' => 'StrategyMode',
'in' => 'query',
'schema' => [
'description' => '调度模式:'."\n"
."\n"
.'- GEO:基于地理位置'."\n"
.'- LATENCY:基于延时',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'GEO',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SelectedDomainLines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SelectedDomainLine' => [
'description' => '主地址池集合已选择域名区域列表。',
'type' => 'array',
'items' => [
'description' => '主地址池集合已选择域名区域。',
'type' => 'string',
'example' => 'telecom',
],
],
],
],
'DomainAddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainAddrPool' => [
'description' => '域名类型可用地址池列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '地址池名称。',
'type' => 'string',
'example' => 'testpool',
],
'AddrCount' => [
'description' => '地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Id' => [
'description' => '地址池id。',
'type' => 'string',
'example' => 'po***',
],
],
],
],
],
],
'Ipv4AddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ipv4AddrPool' => [
'description' => 'Ipv4类型可用地址池列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '地址池名称。',
'type' => 'string',
'example' => 'test****',
],
'AddrCount' => [
'description' => '地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Id' => [
'description' => '地址池id。',
'type' => 'string',
'example' => 'po***',
],
],
],
],
],
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => 'C2851BA9-CE56-49AF-8D12-4FC6A49EE688',
],
'SelectedIpv4Lines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SelectedIpv4Line' => [
'description' => '主地址池集合已选择Ipv4区域列表。',
'type' => 'array',
'items' => [
'description' => '主地址池集合已选择Ipv4区域。',
'type' => 'string',
'example' => 'telecom',
],
],
],
],
'Ipv6AddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Ipv6AddrPool' => [
'description' => 'Ipv6类型可用地址池列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'description' => '地址池名称。',
'type' => 'string',
'example' => 'testpool',
],
'AddrCount' => [
'description' => '地址数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Id' => [
'description' => '地址池id。',
'type' => 'string',
'example' => 'po***',
],
],
],
],
],
],
'SuggestSetDefaultLine' => [
'description' => '建议设置全局线路。'."\n"
."\n",
'type' => 'boolean',
'example' => 'true',
],
'SelectedIpv6Lines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SelectedIpv6Line' => [
'description' => '主地址池集合已选择Ipv6区域列表。',
'type' => 'array',
'items' => [
'description' => '主地址池集合已选择Ipv6区域。',
'type' => 'string',
'example' => 'telecom',
],
],
],
],
'Lines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Line' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FatherCode' => [
'description' => '父线路的code,如果没有则为空。'."\n"
."\n",
'type' => 'string',
'example' => 'telecom',
],
'GroupName' => [
'description' => '解析请求来源分组名称。',
'type' => 'string',
'example' => 'Global',
],
'LineCode' => [
'description' => '解析请求来源编码。',
'type' => 'string',
'example' => 'default',
],
'LineName' => [
'description' => '解析请求来源名称。',
'type' => 'string',
'example' => 'Global',
],
'GroupCode' => [
'description' => '解析请求来源分组编号。',
'type' => 'string',
'example' => 'DEFAULT',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SelectedDomainLines\\": {\\n \\"SelectedDomainLine\\": [\\n \\"telecom\\"\\n ]\\n },\\n \\"DomainAddrPools\\": {\\n \\"DomainAddrPool\\": [\\n {\\n \\"Name\\": \\"testpool\\",\\n \\"AddrCount\\": 1,\\n \\"Id\\": \\"po***\\"\\n }\\n ]\\n },\\n \\"Ipv4AddrPools\\": {\\n \\"Ipv4AddrPool\\": [\\n {\\n \\"Name\\": \\"test****\\",\\n \\"AddrCount\\": 1,\\n \\"Id\\": \\"po***\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"C2851BA9-CE56-49AF-8D12-4FC6A49EE688\\",\\n \\"SelectedIpv4Lines\\": {\\n \\"SelectedIpv4Line\\": [\\n \\"telecom\\"\\n ]\\n },\\n \\"Ipv6AddrPools\\": {\\n \\"Ipv6AddrPool\\": [\\n {\\n \\"Name\\": \\"testpool\\",\\n \\"AddrCount\\": 1,\\n \\"Id\\": \\"po***\\"\\n }\\n ]\\n },\\n \\"SuggestSetDefaultLine\\": true,\\n \\"SelectedIpv6Lines\\": {\\n \\"SelectedIpv6Line\\": [\\n \\"telecom\\"\\n ]\\n },\\n \\"Lines\\": {\\n \\"Line\\": [\\n {\\n \\"FatherCode\\": \\"telecom\\",\\n \\"GroupName\\": \\"Global\\",\\n \\"LineCode\\": \\"default\\",\\n \\"LineName\\": \\"Global\\",\\n \\"GroupCode\\": \\"DEFAULT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n pool1\\n 1\\n testpool\\n \\n\\n\\n \\n pool1\\n 1\\n testpool\\n \\n\\nC2851BA9-CE56-49AF-8D12-4FC6A49EE688\\n\\n \\n pool1\\n 1\\n testpool\\n \\n\\ntrue\\n\\n \\n global\\n default\\n telecom\\n default\\n global\\n \\n","errorExample":""}]',
'title' => '获取访问策略可设置的配置',
'summary' => '通过实例ID获取访问策略可设置的配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmAccessStrategies' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => false,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
[
'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' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0CCC9971-CEC9-4132-824B-4AE611C07623',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Strategies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Strategy' => [
'description' => '策略列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AccessMode' => [
'description' => '访问策略。其中:'."\n"
.'- **AUTO**:自动切换'."\n"
.'- **DEFAULT**:主地址池集合'."\n"
.'- **FAILOVER**:备地址池集合',
'type' => 'string',
'example' => 'AUTO',
],
'StrategyName' => [
'description' => '策略名称。',
'type' => 'string',
'example' => '访问策略',
],
'DefaultAddrPoolMonitorStatus' => [
'description' => '主地址池集合健康检查状态。其中:'."\n"
."\n"
.'- **OPEN**:开启'."\n"
.'- **CLOSE**:关闭'."\n"
.'- **UNCONFIGURED**:未配置',
'type' => 'string',
'example' => 'OPEN',
],
'StrategyMode' => [
'description' => '访问策略类型:'."\n"
."\n"
.'- **GEO**:基于地理位置'."\n"
.'- **LATENCY**:基于延时',
'type' => 'string',
'example' => 'GEO',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2018-08-09T00:10Z',
],
'DefaultAddrPoolStatus' => [
'description' => '主地址池集合可用状态。其中:'."\n"
."\n"
.'- **AVAILABLE**:可用'."\n"
.'- **NOT_AVAILABLE**:不可用',
'type' => 'string',
'example' => 'AVAILABLE',
],
'InstanceId' => [
'description' => '关联实例ID。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**',
],
'Lines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Line' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '解析请求来源分组名称。',
'type' => 'string',
'example' => 'Global',
],
'LineCode' => [
'description' => '解析请求来源编码。',
'type' => 'string',
'example' => 'default',
],
'LineName' => [
'description' => '解析请求来源名称。',
'type' => 'string',
'example' => 'Global',
],
'GroupCode' => [
'description' => '解析请求来源分组编码。',
'type' => 'string',
'example' => 'DEFAULT',
],
],
],
],
],
],
'FailoverAddrPoolId' => [
'description' => '备地址池集合ID。',
'type' => 'string',
'example' => 'hra0i2',
],
'DefaultAddrPoolId' => [
'description' => '主地址池集合ID。',
'type' => 'string',
'example' => 'hra0i1',
],
'StrategyId' => [
'description' => '访问策略ID。',
'type' => 'string',
'example' => 'hra0hs',
],
'FailoverAddrPoolStatus' => [
'description' => '备地址池集合可用状态。其中:'."\n"
."\n"
.'- ****AVAILABLE****:可用'."\n"
.'- ****NOT_AVAILABLE****:不可用',
'type' => 'string',
'example' => 'AVAILABLE',
],
'AccessStatus' => [
'description' => '访问状态。其中:'."\n"
.'- **DEFAULT**:当前访问主地址池集合'."\n"
.'- **FAILOVER**:当前访问备地址池集合',
'type' => 'string',
'example' => 'DEFAULT',
],
'FailoverAddrPoolMonitorStatus' => [
'description' => '备地址池集合健康检查状态。其中:'."\n"
."\n"
.'- **OPEN**:开启'."\n"
.'- **CLOSE**:关闭'."\n"
.'- **UNCONFIGURED**:未配置',
'type' => 'string',
'example' => 'OPEN',
],
'DefaultAddrPoolName' => [
'description' => '主地址池集合名称。',
'type' => 'string',
'example' => '地址池1',
],
'FailoverAddrPoolName' => [
'description' => '备地址池集合名称。',
'type' => 'string',
'example' => '地址池2',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1533773400000',
],
],
],
],
],
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"0CCC9971-CEC9-4132-824B-4AE611C07623\\",\\n \\"PageNumber\\": 1,\\n \\"Strategies\\": {\\n \\"Strategy\\": [\\n {\\n \\"AccessMode\\": \\"AUTO\\",\\n \\"StrategyName\\": \\"访问策略\\",\\n \\"DefaultAddrPoolMonitorStatus\\": \\"OPEN\\",\\n \\"StrategyMode\\": \\"GEO\\",\\n \\"CreateTime\\": \\"2018-08-09T00:10Z\\",\\n \\"DefaultAddrPoolStatus\\": \\"AVAILABLE\\",\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3hbz**\\",\\n \\"Lines\\": {\\n \\"Line\\": [\\n {\\n \\"GroupName\\": \\"Global\\",\\n \\"LineCode\\": \\"default\\",\\n \\"LineName\\": \\"Global\\",\\n \\"GroupCode\\": \\"DEFAULT\\"\\n }\\n ]\\n },\\n \\"FailoverAddrPoolId\\": \\"hra0i2\\",\\n \\"DefaultAddrPoolId\\": \\"hra0i1\\",\\n \\"StrategyId\\": \\"hra0hs\\",\\n \\"FailoverAddrPoolStatus\\": \\"AVAILABLE\\",\\n \\"AccessStatus\\": \\"DEFAULT\\",\\n \\"FailoverAddrPoolMonitorStatus\\": \\"OPEN\\",\\n \\"DefaultAddrPoolName\\": \\"地址池1\\",\\n \\"FailoverAddrPoolName\\": \\"地址池2\\",\\n \\"CreateTimestamp\\": 1533773400000\\n }\\n ]\\n },\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\r\\n1\\r\\n\\t20\\r\\n\\t0CCC9971-CEC9-4132-824B-4AE611C07623\\r\\n\\t1\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t地址池2\\r\\n\\t\\t\\tAVAILABLE\\r\\n\\t\\t\\tOPEN\\r\\n\\t\\t\\t访问策略测试\\r\\n\\t\\t\\tDEFAULT\\r\\n\\t\\t\\t1533773400000\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t全局\\r\\n\\t\\t\\t\\t\\tDEFAULT\\r\\n\\t\\t\\t\\t\\t全局\\r\\n\\t\\t\\t\\t\\tdefault\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tSELF_DEFINED\\r\\n\\t\\t\\thra0i1\\r\\n\\t\\t\\t2018-08-09T00:10Z\\r\\n\\t\\t\\thra0i2\\r\\n\\t\\t\\t地址池1\\r\\n\\t\\t\\tAVAILABLE\\r\\n\\t\\t\\tCLOSE\\r\\n\\t\\t\\tDEFAULT\\r\\n\\t\\t\\tinstance1\\r\\n\\t\\t\\thra0hs\\r\\n\\t\\t\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '获取实例访问策略列表(旧版)',
'summary' => '获取当前实例的访问策略列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmAccessStrategy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StrategyId',
'in' => 'query',
'schema' => [
'description' => '访问策略ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'hra0hs',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'BA1608CA-834C-4E63-8682-8AF0B11ED72D',
],
'InstanceId' => [
'description' => '关联的GTM实例ID。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**',
],
'StrategyId' => [
'description' => '策略ID。',
'type' => 'string',
'example' => 'hra0hs',
],
'DefaultAddrPoolStatus' => [
'description' => '主地址池集合可用状态。其中:'."\n"
."\n"
.'- **AVAILABLE**:可用'."\n"
.'- **NOT_AVAILABLE**:不可用',
'type' => 'string',
'example' => 'AVAILABLE',
],
'FailoverAddrPoolId' => [
'description' => '备地址池集合ID。'."\n"
.'若未设置备地址池集合,传值**EMPTY**。',
'type' => 'string',
'example' => 'hra0i2',
],
'AccessStatus' => [
'description' => '访问状态。其中:'."\n"
."\n"
.'- **DEFAULT**:访问主地址池集合,表示正常'."\n"
.'- **FAILOVER**:访问备地址池集合,表示异常',
'type' => 'string',
'example' => 'DEFAULT',
],
'DefaultAddrPoolMonitorStatus' => [
'description' => '主地址池集合健康检查状态。其中:'."\n"
."\n"
.'- **OPEN**:开启'."\n"
.'- **CLOSE**:关闭'."\n"
.'- **UNCONFIGURED**:未配置',
'type' => 'string',
'example' => 'OPEN',
],
'DefaultAddrPoolName' => [
'description' => '主地址池集合名称。',
'type' => 'string',
'example' => '地址池1',
],
'DefultAddrPoolId' => [
'description' => '备地址池集合ID。',
'type' => 'string',
'example' => 'hra0i1',
],
'StrategyName' => [
'description' => '访问策略名称。',
'type' => 'string',
'example' => '全局',
],
'FailoverAddrPoolStatus' => [
'description' => '备地址池集合可用状态。其中:'."\n"
."\n"
.'- **AVAILABLE**:可用'."\n"
.'- **NOT_AVAILABLE**:不可用',
'type' => 'string',
'example' => 'AVAILABLE',
],
'AccessMode' => [
'description' => '地址池集合切换策略:'."\n"
."\n"
.'- **AUTO**:自动切换'."\n"
.'- **DEFAULT**:主地址池集合'."\n"
.'- **FAILOVER**: 备地址池集合',
'type' => 'string',
'example' => 'AUTO',
],
'StrategyMode' => [
'description' => '策略模式'."\n"
.'SELF_DEFINED 自定义。',
'type' => 'string',
'example' => 'SELF_DEFINED',
],
'FailoverAddrPoolMonitorStatus' => [
'description' => '备地址池集合健康检查状态。其中:'."\n"
."\n"
.'- **OPEN**:开启'."\n"
.'- **CLOSE**:关闭'."\n"
.'- **UNCONFIGURED**:未配置',
'type' => 'string',
'example' => 'OPEN',
],
'FailoverAddrPoolName' => [
'description' => '备地址池集合名称。',
'type' => 'string',
'example' => '地址池2',
],
'Lines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Line' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '解析请求来源分组名称。',
'type' => 'string',
'example' => 'Global',
],
'LineCode' => [
'description' => '解析请求来源编码。',
'type' => 'string',
'example' => 'default',
],
'LineName' => [
'description' => '解析请求来源名称。',
'type' => 'string',
'example' => 'Global',
],
'GroupCode' => [
'description' => '解析请求来源分组编码。',
'type' => 'string',
'example' => 'DEFAULT',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA1608CA-834C-4E63-8682-8AF0B11ED72D\\",\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3hbz**\\",\\n \\"StrategyId\\": \\"hra0hs\\",\\n \\"DefaultAddrPoolStatus\\": \\"AVAILABLE\\",\\n \\"FailoverAddrPoolId\\": \\"hra0i2\\",\\n \\"AccessStatus\\": \\"DEFAULT\\",\\n \\"DefaultAddrPoolMonitorStatus\\": \\"OPEN\\",\\n \\"DefaultAddrPoolName\\": \\"地址池1\\",\\n \\"DefultAddrPoolId\\": \\"hra0i1\\",\\n \\"StrategyName\\": \\"全局\\",\\n \\"FailoverAddrPoolStatus\\": \\"AVAILABLE\\",\\n \\"AccessMode\\": \\"AUTO\\",\\n \\"StrategyMode\\": \\"SELF_DEFINED\\",\\n \\"FailoverAddrPoolMonitorStatus\\": \\"OPEN\\",\\n \\"FailoverAddrPoolName\\": \\"地址池2\\",\\n \\"Lines\\": {\\n \\"Line\\": [\\n {\\n \\"GroupName\\": \\"Global\\",\\n \\"LineCode\\": \\"default\\",\\n \\"LineName\\": \\"Global\\",\\n \\"GroupCode\\": \\"DEFAULT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t访问策略测试\\r\\n\\tDEFAULT\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tGlobal\\r\\n\\t\\t\\tDEFAULT\\r\\n\\t\\t\\tGlobal\\r\\n\\t\\t\\tdefault\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tISP\\r\\n\\t\\t\\tISP\\r\\n\\t\\t\\tmobile\\r\\n\\t\\t\\tChina Mobile\\r\\n\\t\\t\\r\\n\\t\\r\\n\\tBA1608CA-834C-4E63-8682-8AF0B11ED72D\\r\\n\\tDEFAULT\\r\\n\\t2018-08-09T00:10Z\\r\\n\\t1533773400000\\r\\n\\thra0i1\\r\\n\\t地址池1\\r\\n\\thra0i2\\r\\n\\t地址池2\\r\\n\\tinstance1\\r\\n\\tSELF_DEFINED\\r\\n\\thra0hs\\r\\n\\tAVAILABLE\\r\\n\\tOPEN\\r\\n\\tAVAILABLE\\r\\n\\tCLOSE\\r\\n","errorExample":""}]',
'title' => '获取访问策略详细信息(旧版)',
'summary' => '根据策略ID获取策略详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeGtmAccessStrategyAvailableConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => 'GTM实例ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-wwo3a3hbz**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'C2851BA9-CE56-49AF-8D12-4FC6A49EE688',
],
'AddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddrPool' => [
'description' => '地址池列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AddrPoolId' => [
'description' => '地址池ID。',
'type' => 'string',
'example' => 'hra0ix',
],
'AddrPoolName' => [
'description' => '地址池名称。',
'type' => 'string',
'example' => 'test',
],
],
],
],
],
],
'Lines' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Line' => [
'description' => '解析请求来源列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '线路当前状态。其中:'."\n"
."\n"
.'- **FORBIDDEN**:不可选'."\n"
.'- **OPTIONAL**:可选择',
'type' => 'string',
'example' => 'FORBIDDEN',
],
'FatherCode' => [
'description' => '父线路的code,如果没有则为空。',
'type' => 'string',
'example' => '无',
],
'LineCode' => [
'description' => '解析请求来源编码。',
'type' => 'string',
'example' => 'cn_region_huanan',
],
'GroupName' => [
'description' => '解析请求来源分组名称。',
'type' => 'string',
'example' => 'Mainland China',
],
'LineName' => [
'description' => '解析请求来源名称。',
'type' => 'string',
'example' => 'South China',
],
'GroupCode' => [
'description' => '解析请求来源分组编号。',
'type' => 'string',
'example' => 'CN_REGION',
],
],
],
],
],
],
'SuggestSetDefaultLine' => [
'description' => '建议设置全局线路。'."\n"
."\n",
'type' => 'boolean',
'example' => 'True',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C2851BA9-CE56-49AF-8D12-4FC6A49EE688\\",\\n \\"AddrPools\\": {\\n \\"AddrPool\\": [\\n {\\n \\"AddrPoolId\\": \\"hra0ix\\",\\n \\"AddrPoolName\\": \\"test\\"\\n }\\n ]\\n },\\n \\"Lines\\": {\\n \\"Line\\": [\\n {\\n \\"Status\\": \\"FORBIDDEN\\",\\n \\"FatherCode\\": \\"无\\",\\n \\"LineCode\\": \\"cn_region_huanan\\",\\n \\"GroupName\\": \\"Mainland China\\",\\n \\"LineName\\": \\"South China\\",\\n \\"GroupCode\\": \\"CN_REGION\\"\\n }\\n ]\\n },\\n \\"SuggestSetDefaultLine\\": true\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\t\\r\\n\\t\\t\\tFORBIDDEN\\r\\n\\t\\t\\t全局\\r\\n\\t\\t\\tDEFAULT\\r\\n\\t\\t\\t全局\\r\\n\\t\\t\\tdefault\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tOPTIONAL\\r\\n\\t\\t\\t运营商\\r\\n\\t\\t\\tISP\\r\\n\\t\\t\\t电信\\r\\n\\t\\t\\ttelecom\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tOPTIONAL\\r\\n\\t\\t\\t境外地区\\r\\n\\t\\t\\tOS\\r\\n\\t\\t\\t南美洲\\r\\n\\t\\t\\tos_samerica\\r\\n\\t\\t\\r\\n\\t\\r\\n\\tC2851BA9-CE56-49AF-8D12-4FC6A49EE688\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t地址池1\\r\\n\\t\\t\\thra0ix\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t地址池2\\r\\n\\t\\t\\thra0iy\\r\\n\\t\\t\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '获取访问策略可设置的配置(旧版)',
'summary' => '获取当前访问策略可设置的配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SwitchDnsGtmInstanceStrategyMode' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '部分返回参数语言。默认值:en。取值范围:en、zh、ja。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例id。可通过调用[DescribeDnsGtmInstances](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_8_8.2aea3618RlSR9K)获取'."\n"
.'可通过调用[DescribeDnsGtmInstances](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describednsgtminstances?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'gtm-cn-cs02xyk4a**',
],
],
[
'name' => 'StrategyMode',
'in' => 'query',
'schema' => [
'description' => '访问策略模式:'."\n"
."\n"
.'- GEO:基于地理位置'."\n"
.'- LATENCY:基于延时',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'GEO',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"6856BCF6-11D6-4D7E-AC53-FD579933522B","errorExample":""}]',
'title' => '切换访问策略类型',
'summary' => '通过实例ID切换访问策略类型。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddGtmRecoveryPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '用户语言',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '容灾预案名称',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'name-example',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'remark',
],
],
[
'name' => 'FaultAddrPool',
'in' => 'query',
'schema' => [
'description' => '故障地址池ID列表',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["hra0or"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RecoveryPlanId' => [
'description' => '容灾预案ID',
'type' => 'string',
'example' => '100',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RecoveryPlanId\\": \\"100\\",\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n\\t100\\r\\n","errorExample":""}]',
'title' => '新增容灾预案',
'summary' => '新增容灾预案。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteGtmRecoveryPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'RecoveryPlanId',
'in' => 'query',
'schema' => [
'description' => '容灾预案ID。可通过调用[DescribeGtmRecoveryPlans ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_13_5.6dd83618vW4yD7)获取'."\n"
.'可通过调用[DescribeGtmRecoveryPlans ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '10********',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n6856BCF6-11D6-4D7E-AC53-FD579933522B\\r\\n","errorExample":""}]',
'title' => '删除容灾预案',
'summary' => '删除容灾预案。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateGtmRecoveryPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'RecoveryPlanId',
'in' => 'query',
'schema' => [
'description' => '容灾预案ID。可通过调用[DescribeGtmRecoveryPlans ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_13_5.6dd83618vW4yD7)获取'."\n"
.'可通过调用[DescribeGtmRecoveryPlans ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '10*******',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'description' => '容灾预案名称',
'type' => 'string',
'required' => false,
'example' => 'abc',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注信息',
'type' => 'string',
'required' => false,
'example' => 'remark',
],
],
[
'name' => 'FaultAddrPool',
'in' => 'query',
'schema' => [
'description' => '故障地址池 ID 列表',
'type' => 'string',
'required' => false,
'example' => '["hra0**"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '575A3E3A-E9FC-5435-9CAD-BD89533E****',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"575A3E3A-E9FC-5435-9CAD-BD89533E****\\"\\n}","type":"json"}]',
'title' => '修改容灾预案',
'summary' => '修改容灾预案。',
],
'DescribeGtmRecoveryPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'RecoveryPlanId',
'in' => 'query',
'schema' => [
'description' => '容灾预案ID。可通过调用[DescribeGtmRecoveryPlans ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_13_5.6dd83618vW4yD7)获取'."\n"
.'可通过调用[DescribeGtmRecoveryPlans ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '10*****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '容灾预案状态:'."\n"
."\n"
.'- UNEXECUTED:容灾域名处于未执行状态;'."\n"
."\n"
.'- EXECUTED:容灾域名处于执行状态;'."\n"
."\n"
.'- ROLLED_BACK:容灾预案处于回滚状态;',
'type' => 'string',
'example' => 'UNEXECUTED',
],
'LastRollbackTime' => [
'description' => '最近回滚时间(时间戳)',
'type' => 'string',
'example' => '1565505919000',
],
'FaultAddrPoolNum' => [
'description' => '故障地址池个数',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'FaultAddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FaultAddrPool' => [
'description' => '故障地址池列表',
'type' => 'array',
'items' => [
'description' => '故障地址池列表',
'type' => 'object',
'properties' => [
'Addrs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Addr' => [
'description' => '地址列表',
'type' => 'array',
'items' => [
'description' => '地址列表',
'type' => 'object',
'properties' => [
'Value' => [
'description' => '地址值',
'type' => 'string',
'example' => '1.1.XX.XX',
],
'Mode' => [
'description' => '地址模式:'."\n"
."\n"
.'- ONLINE:永远在线,不论健康检查是否异常,该地址均可解析;'."\n"
."\n"
.'- OFFLINE:永远离线,不论健康检查是否异常,该地址均不可解析;'."\n"
."\n"
.'- SMART:智能返回,根据健康检查的状态决定该地址是否可解析;',
'type' => 'string',
'example' => 'SMART',
],
'Id' => [
'description' => '地址ID',
'type' => 'integer',
'format' => 'int64',
'example' => '73**',
],
],
],
],
],
],
'AddrPoolId' => [
'description' => '地址池ID',
'type' => 'string',
'example' => 'hra0**',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'gtm-cn-zz11t58****',
],
'AddrPoolName' => [
'description' => '地址池名称',
'type' => 'string',
'example' => '压测-Failover-1',
],
],
],
],
],
],
'LastExecuteTime' => [
'description' => '最近执行时间',
'type' => 'string',
'example' => '2019-08-11T05:04Z',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '0A5F4315-D6E8-435E-82DF-24F4C97D6999',
],
'CreateTime' => [
'description' => '创建时间',
'type' => 'string',
'example' => '2019-08-11T05:04Z',
],
'LastExecuteTimestamp' => [
'description' => '最近执行时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1565505898000',
],
'Remark' => [
'description' => '备注',
'type' => 'string',
'example' => 'remark-example',
],
'Name' => [
'description' => '容灾预案名称',
'type' => 'string',
'example' => 'name-example',
],
'RecoveryPlanId' => [
'description' => '容灾预案ID',
'type' => 'integer',
'format' => 'int64',
'example' => '10****',
],
'UpdateTime' => [
'description' => '更新时间',
'type' => 'string',
'example' => '2024-03-29T13:20Z',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1565505898000',
],
'LastRollbackTimestamp' => [
'description' => '最近回滚时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1565505898000',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1565499867000',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"UNEXECUTED\\",\\n \\"LastRollbackTime\\": \\"1565505919000\\",\\n \\"FaultAddrPoolNum\\": 2,\\n \\"FaultAddrPools\\": {\\n \\"FaultAddrPool\\": [\\n {\\n \\"Addrs\\": {\\n \\"Addr\\": [\\n {\\n \\"Value\\": \\"1.1.XX.XX\\",\\n \\"Mode\\": \\"SMART\\",\\n \\"Id\\": 0\\n }\\n ]\\n },\\n \\"AddrPoolId\\": \\"hra0**\\",\\n \\"InstanceId\\": \\"gtm-cn-zz11t58****\\",\\n \\"AddrPoolName\\": \\"压测-Failover-1\\"\\n }\\n ]\\n },\\n \\"LastExecuteTime\\": \\"2019-08-11T05:04Z\\",\\n \\"RequestId\\": \\"0A5F4315-D6E8-435E-82DF-24F4C97D6999\\",\\n \\"CreateTime\\": \\"2019-08-11T05:04Z\\",\\n \\"LastExecuteTimestamp\\": 1565505898000,\\n \\"Remark\\": \\"remark-example\\",\\n \\"Name\\": \\"name-example\\",\\n \\"RecoveryPlanId\\": 0,\\n \\"UpdateTime\\": \\"2024-03-29T13:20Z\\",\\n \\"UpdateTimestamp\\": 1565505898000,\\n \\"LastRollbackTimestamp\\": 1565505898000,\\n \\"CreateTimestamp\\": 1565499867000\\n}","type":"json"}]',
'title' => '获取容灾预案详情',
'summary' => '获取容灾预案详情。',
],
'DescribeGtmRecoveryPlanAvailableConfig' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Instance' => [
'description' => '实例列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AddrPools' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AddrPool' => [
'description' => '地址池列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AddrPoolId' => [
'description' => '地址池ID',
'type' => 'string',
'example' => '10*******',
],
'Name' => [
'description' => '地址池名称',
'type' => 'string',
'example' => 'hra0i9',
],
],
],
],
],
],
'InstanceName' => [
'description' => '实例名称',
'type' => 'string',
'example' => 'test',
],
'InstanceId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'gtm-cn-kvw3uk8****',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => 'F8F8EF50-8B7F-4702-B294-97170A423403',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"AddrPools\\": {\\n \\"AddrPool\\": [\\n {\\n \\"AddrPoolId\\": \\"10*******\\",\\n \\"Name\\": \\"hra0i9\\"\\n }\\n ]\\n },\\n \\"InstanceName\\": \\"test\\",\\n \\"InstanceId\\": \\"gtm-cn-kvw3uk8****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"F8F8EF50-8B7F-4702-B294-97170A423403\\"\\n}","type":"json"}]',
'title' => '获取容灾预案可设置的配置',
'summary' => '获取容灾预案可设置的配置。',
],
'DescribeGtmRecoveryPlans' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
."\n"
.'zh:中文'."\n"
."\n"
.'en:英文'."\n"
."\n"
.'默认:zh',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '查询关键字。支持容灾预案名称模糊匹配。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'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' => [
'RecoveryPlans' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RecoveryPlan' => [
'description' => '容灾预案列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '预案状态。其中:'."\n"
."\n"
.'- **UNEXECUTED**:未执行'."\n"
.'- **EXECUTED**:已执行'."\n"
.'- **ROLLED_BACK**:已回滚',
'type' => 'string',
'example' => 'UNEXECUTED',
],
'LastRollbackTimestamp' => [
'description' => '最近回滚时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1565505919000',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2019-08-11T06:45Z',
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'example' => 'remark-example',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2019-08-11T06:45Z',
],
'RecoveryPlanId' => [
'description' => '容灾预案ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '5****',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1565505919000',
],
'LastExecuteTimestamp' => [
'description' => '最近执行时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1565505898000',
],
'LastExecuteTime' => [
'description' => '最近执行时间。',
'type' => 'string',
'example' => '2019-08-11T06:44Z',
],
'LastRollbackTime' => [
'description' => '最近回滚时间。',
'type' => 'string',
'example' => '2019-08-11T06:45Z',
],
'Name' => [
'description' => '容灾预案名称。',
'type' => 'string',
'example' => 'name-example',
],
'FaultAddrPoolNum' => [
'description' => '故障地址池个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1565499867000',
],
],
],
],
],
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '2BA072CF-CA21-4A34-B6C2-227BE2C58079',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RecoveryPlans\\": {\\n \\"RecoveryPlan\\": [\\n {\\n \\"Status\\": \\"UNEXECUTED\\",\\n \\"LastRollbackTimestamp\\": 1565505919000,\\n \\"UpdateTime\\": \\"2019-08-11T06:45Z\\",\\n \\"Remark\\": \\"remark-example\\",\\n \\"CreateTime\\": \\"2019-08-11T06:45Z\\",\\n \\"RecoveryPlanId\\": 0,\\n \\"UpdateTimestamp\\": 1565505919000,\\n \\"LastExecuteTimestamp\\": 1565505898000,\\n \\"LastExecuteTime\\": \\"2019-08-11T06:44Z\\",\\n \\"LastRollbackTime\\": \\"2019-08-11T06:45Z\\",\\n \\"Name\\": \\"name-example\\",\\n \\"FaultAddrPoolNum\\": 0,\\n \\"CreateTimestamp\\": 1565499867000\\n }\\n ]\\n },\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"2BA072CF-CA21-4A34-B6C2-227BE2C58079\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\r\\n1\\r\\n\\t20\\r\\n\\t2BA072CF-CA21-4A34-B6C2-227BE2C58079\\r\\n\\t10\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t1565499867000\\r\\n\\t\\t\\t2019-08-11T06:45Z\\r\\n\\t\\t\\t1565505919000\\r\\n\\t\\t\\t2019-08-11T06:45Z\\r\\n\\t\\t\\t55\\r\\n\\t\\t\\tname-example\\r\\n\\t\\t\\t1565505919000\\r\\n\\t\\t\\tROLLED_BACK\\r\\n\\t\\t\\t1565505898000\\r\\n\\t\\t\\t2019-08-11T05:04Z\\r\\n\\t\\t\\t2019-08-11T06:44Z\\r\\n\\t\\t\\t0\\r\\n\\t\\t\\tremark-example\\r\\n\\t\\t\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '获取容灾预案列表',
'summary' => '获取容灾预案列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ExecuteGtmRecoveryPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'RecoveryPlanId',
'in' => 'query',
'schema' => [
'description' => '容灾预案ID。可通过调用[DescribeGtmRecoveryPlans ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_13_5.6dd83618vW4yD7)获取'."\n"
.'可通过调用[DescribeGtmRecoveryPlans ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '10**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","type":"json"}]',
'title' => '执行容灾预案',
'summary' => '执行容灾预案。',
],
'PreviewGtmRecoveryPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'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' => 'RecoveryPlanId',
'in' => 'query',
'schema' => [
'description' => '容灾预案ID。可通过调用[DescribeGtmRecoveryPlans ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_13_5.6dd83618vW4yD7)获取'."\n"
.'可通过调用[DescribeGtmRecoveryPlans ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '10**',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值**20**,默认为**5**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '853805EA-3D47-47D5-9A1A-A45C24313ABD',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Previews' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Preview' => [
'description' => '容灾预案执行预览。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'gtm-cn-wwo3a3hbz**',
],
'SwitchInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SwitchInfo' => [
'description' => '切换信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StrategyName' => [
'description' => '策略名称。',
'type' => 'string',
'example' => 'hrb5ju',
],
'Content' => [
'description' => '格式化的消息内容。',
'type' => 'string',
'example' => '默认地址池(默认地址池1)切换备用地址池(备用地址池1)',
],
],
],
],
],
],
'Name' => [
'description' => '实例名称。',
'type' => 'string',
'example' => 'name-example',
],
'UserDomainName' => [
'description' => '用户域名(列表)。',
'type' => 'string',
'example' => 'example.com',
],
],
],
],
],
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TotalItems' => [
'description' => '总个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 5,\\n \\"RequestId\\": \\"853805EA-3D47-47D5-9A1A-A45C24313ABD\\",\\n \\"PageNumber\\": 1,\\n \\"Previews\\": {\\n \\"Preview\\": [\\n {\\n \\"InstanceId\\": \\"gtm-cn-wwo3a3hbz**\\",\\n \\"SwitchInfos\\": {\\n \\"SwitchInfo\\": [\\n {\\n \\"StrategyName\\": \\"hrb5ju\\",\\n \\"Content\\": \\"默认地址池(默认地址池1)切换备用地址池(备用地址池1)\\"\\n }\\n ]\\n },\\n \\"Name\\": \\"name-example\\",\\n \\"UserDomainName\\": \\"example.com\\"\\n }\\n ]\\n },\\n \\"TotalPages\\": 3,\\n \\"TotalItems\\": 15\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t1\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tname-example\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tstrategy-name-example-1\\r\\n\\t\\t\\t\\t\\t默认地址池(默认地址池1) 切换 备用地址池(备用地址池1)\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tstrategy-name-examle-2\\r\\n\\t\\t\\t\\t\\t默认地址池(默认地址池2) 切换 备用地址池(备用地址池2)\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tinstance-example\\r\\n\\t\\t\\t30.yyy.com\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t5\\r\\n\\t853805EA-3D47-47D5-9A1A-A45C24313ABD\\r\\n\\t15\\r\\n\\t3\\r\\n","errorExample":""}]',
'title' => '预览容灾预案',
'summary' => '预览容灾预案。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RollbackGtmRecoveryPlan' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'RecoveryPlanId',
'in' => 'query',
'schema' => [
'description' => '容灾预案ID。可通过调用[DescribeGtmRecoveryPlans ](https://help.aliyun.com/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c4g.11186623.help-menu-29697.d_0_5_1_3_13_5.6dd83618vW4yD7)获取'."\n"
.'可通过调用[DescribeGtmRecoveryPlans ](https://www.alibabacloud.com/help/zh/dns/api-alidns-2015-01-09-describegtmrecoveryplans?spm=a2c63.p38356.help-menu-search-29697.d_0)获取',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '10**',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '853805EA-3D47-47D5-9A1A-A45C24313ABD',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"853805EA-3D47-47D5-9A1A-A45C24313ABD\\"\\n}","type":"json"}]',
'title' => '回滚容灾预案',
'summary' => '回滚容灾预案。',
],
'AddRecursionZone' => [
'summary' => '新增HTTPDNS内置权威域名zone',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ZoneName',
'in' => 'query',
'schema' => [
'description' => '域名(Zone)名称。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'ProxyPattern',
'in' => 'query',
'schema' => [
'description' => '是否开启子域名递归代理。取值:'."\n"
."\n"
.'zone: 关闭(当解析本域名下不存在的子域名时,直接返回NXDOMAIN,表示子域名不存在)'."\n"
.'record: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)',
'type' => 'string',
'required' => false,
'example' => 'record',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '用户生成的请求token。用于保证请求的幂等性。该参数值可自定义,但是要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '1ae05db4-10e7-11ef-b126-00163e24**22',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '51899B6F-04A5-5B96-977D-340673091ACA',
],
'Success' => [
'description' => '本次操作是否成功,取值:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'ZoneId' => [
'description' => 'Zone ID。',
'type' => 'string',
'example' => '173671468000011',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51899B6F-04A5-5B96-977D-340673091ACA\\",\\n \\"Success\\": true,\\n \\"ZoneId\\": \\"173671468000011\\"\\n}","type":"json"}]',
'title' => '新增HTTPDNS内置权威域名zone',
'description' => '每个IP段的IP地址必须满足: EndIp >=StartIp。
'."\n"
.'域名下所有自定义线路中的所有IP段,IP范围都不能交叉重叠。',
],
'DescribeRecursionZone' => [
'summary' => '查询HTTPDNS内置权威域名zone详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '241101',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => 'Zone ID,Zone的唯一识别码。',
'type' => 'string',
'required' => false,
'example' => '169783221000012',
'pattern' => '^\\d+$',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'ZoneId' => [
'title' => 'zone ID',
'description' => 'Zone ID,Zone的唯一识别码。'."\n"
."\n",
'type' => 'string',
'example' => '169438909000011',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2018-06-06T11:34Z',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1533773400000',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2018-01-03T08:57Z',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'ZoneName' => [
'title' => 'zone 名称',
'description' => 'zone 名称',
'type' => 'string',
'example' => 'cheng.suow.cc',
],
'UserId' => [
'title' => 'user Id',
'description' => '用户ID',
'type' => 'string',
'example' => '1527690629357',
],
'ProxyPattern' => [
'title' => '代理模式',
'description' => '是否开启子域名递归代理。取值:'."\n"
."\n"
.'zone: 关闭(当解析本域名下不存在的子域名时,直接返回NXDOMAIN,表示子域名不存在)'."\n"
.'record: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)',
'type' => 'string',
'example' => 'record',
],
'RecordCount' => [
'description' => '域名Zone下的解析记录数量',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'Remark' => [
'title' => '备注',
'description' => '备注',
'type' => 'string',
'example' => 'test',
],
'Creator' => [
'title' => '创建者 id',
'description' => '创建者 id',
'type' => 'string',
'example' => 'SOAR',
],
'CreatorType' => [
'title' => '创建者类型',
'description' => '创建者类型',
'type' => 'string',
'example' => 'USER',
],
'CreatorSubType' => [
'title' => '创建者子类型',
'description' => '创建者子类型',
'type' => 'string',
'example' => 'SUB',
],
'EffectiveScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EffectiveScope' => [
'title' => '生效范围数组',
'description' => '内置权威域名zone生效范围',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EffectiveType' => [
'description' => '内置权威域名zone生效类型'."\n"
.'account:递归解析为用户分配的account id',
'type' => 'string',
'example' => 'account',
],
'Scopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Scope' => [
'description' => '生效范围。'."\n"
.'account生效类型则对应为account id列表',
'example' => '[20003]',
'type' => 'array',
'items' => [
'description' => '生效范围子元素'."\n"
.'若生效类型为account则对应单个account id',
'type' => 'string',
'example' => '20003',
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"ZoneId\\": \\"169438909000011\\",\\n \\"CreateTime\\": \\"2018-06-06T11:34Z\\",\\n \\"CreateTimestamp\\": 1533773400000,\\n \\"UpdateTime\\": \\"2018-01-03T08:57Z\\",\\n \\"UpdateTimestamp\\": 1527690629357,\\n \\"ZoneName\\": \\"cheng.suow.cc\\",\\n \\"UserId\\": \\"1527690629357\\",\\n \\"ProxyPattern\\": \\"record\\",\\n \\"RecordCount\\": 8,\\n \\"Remark\\": \\"test\\",\\n \\"Creator\\": \\"SOAR\\",\\n \\"CreatorType\\": \\"USER\\",\\n \\"CreatorSubType\\": \\"SUB\\",\\n \\"EffectiveScopes\\": {\\n \\"EffectiveScope\\": [\\n {\\n \\"EffectiveType\\": \\"account\\",\\n \\"Scopes\\": {\\n \\"Scope\\": [\\n \\"20003\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询HTTPDNS内置权威域名zone详情',
'description' => '实时数据的统计维度是按小时。',
],
'ListRecursionZones' => [
'summary' => '查询HTTPDNS内置权威域名zone内置权威域名zone',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '241053',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ZoneName',
'in' => 'query',
'schema' => [
'description' => '域名Zone名称。',
'type' => 'string',
'required' => false,
'example' => 'lisheng999.com',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注信息。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '本次请求所返回的最大记录条数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '下一个查询开始Token。',
'type' => 'string',
'required' => false,
'example' => '4698691',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页个数。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '获取到地址列表中的地址总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Zones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Zone' => [
'description' => '当前地域支持的可用区列表',
'type' => 'array',
'items' => [
'description' => '当前地域支持的可用区列表',
'type' => 'object',
'properties' => [
'ZoneId' => [
'title' => 'zone ID',
'description' => 'Zone ID,Zone的唯一识别码。',
'type' => 'string',
'example' => '173671468000011',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2021-03-08T05:45Z',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1729674680000',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2024-11-12T04:30Z',
],
'UpdateTimestamp' => [
'description' => '修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1707189878000',
],
'ZoneName' => [
'title' => 'zone名称',
'description' => 'zone名称',
'type' => 'string',
'example' => 'dfsdfsd',
],
'Remark' => [
'title' => '备注',
'description' => '备注',
'type' => 'string',
'example' => '107',
],
'RecordCount' => [
'description' => 'Zone含有的解析记录条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'ProxyPattern' => [
'title' => '代理模式',
'description' => '是否开启子域名递归代理。取值:'."\n"
."\n"
.'zone: 关闭(当解析本域名下不存在的子域名时,直接返回NXDOMAIN,表示子域名不存在)'."\n"
.'record: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)',
'type' => 'string',
'example' => 'record',
],
'Creator' => [
'title' => '创建者',
'description' => '创建者',
'type' => 'string',
'example' => '218497924149333932',
],
'CreatorType' => [
'title' => '创建者类型',
'description' => '创建者类型'."\n"
.'user用户,system系统',
'type' => 'string',
'example' => 'USER',
],
'CreatorSubType' => [
'title' => '创建者子类型',
'description' => '账号类型。说明:'."\n"
."\n"
.'custom:主账号'."\n"
.'sub:子账号'."\n"
.'sts:角色扮演'."\n"
.'other:其他'."\n",
'type' => 'string',
'example' => 'SUB',
],
'EffectiveScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EffectiveScope' => [
'title' => '解析范围',
'description' => '解析范围',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EffectiveType' => [
'title' => '解析范围类型',
'description' => '生效范围类型'."\n"
.'account:账户',
'type' => 'string',
'example' => 'account',
],
'Scopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Scope' => [
'title' => '解析范围值列表',
'description' => '解析范围值列表',
'type' => 'array',
'items' => [
'description' => '生效范围,和生效范围类型对应'."\n"
.'account类型对应 用户的递归解析accountId泪表',
'type' => 'string',
'example' => '20003',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'MaxResults' => [
'description' => '本次请求所返回的最大记录条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'NextToken' => [
'description' => '下一个查询开始Token。',
'type' => 'string',
'example' => '4698691',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1,\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"173671468000011\\",\\n \\"CreateTime\\": \\"2021-03-08T05:45Z\\",\\n \\"CreateTimestamp\\": 1729674680000,\\n \\"UpdateTime\\": \\"2024-11-12T04:30Z\\",\\n \\"UpdateTimestamp\\": 1707189878000,\\n \\"ZoneName\\": \\"dfsdfsd\\",\\n \\"Remark\\": \\"107\\",\\n \\"RecordCount\\": 8,\\n \\"ProxyPattern\\": \\"record\\",\\n \\"Creator\\": \\"218497924149333932\\",\\n \\"CreatorType\\": \\"USER\\",\\n \\"CreatorSubType\\": \\"SUB\\",\\n \\"EffectiveScopes\\": {\\n \\"EffectiveScope\\": [\\n {\\n \\"EffectiveType\\": \\"account\\",\\n \\"Scopes\\": {\\n \\"Scope\\": [\\n \\"20003\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"4698691\\"\\n}","type":"json"}]',
'title' => '查询HTTPDNS内置权威域名zone',
'description' => '- 请求中至少指定参数ResourceId.N或Tag.N(Tag.N.Key与Tag.N.Value),以确定检索对象。'."\n"
.'- Tag.N是资源的标签,由一个键值对组成。仅指定Tag.N.Key时,则返回该标签键关联的所有标签值。仅指定Tag.N.Value会报错。'."\n"
.'- 如果您同时指定Tag.N和ResourceId.N筛选标签,则ResourceId.N必须满足所有输入的标签键值对。'."\n"
.'- 如果您同时指定多个标签键值对,返回结果为同时包含被指定的多个键值对的资源。',
],
'DeleteRecursionZone' => [
'summary' => '删除HTTPDNS内置权威域名zone',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => 'Zone ID。Zone ID,Zone的唯一识别码。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => '169783221000012',
'pattern' => '^\\d+$',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。'."\n"
."\n"
.'从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '21079fa016944979537637959d09bc',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA\\"\\n}","type":"json"}]',
'title' => '删除HTTPDNS内置权威域名zone',
'description' => '如果被删除的解析记录中存在锁定解析,则该锁定解析不会被删除。',
],
'SearchRecursionZones' => [
'summary' => '搜索HTTPDNS内置权威域名zone',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '241109',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ZoneName',
'in' => 'query',
'schema' => [
'description' => '域名(Zone)名称。',
'type' => 'string',
'required' => false,
'example' => 'cheng.suow.cc',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '地址池备注,支持对输入的备注进行模糊搜索。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '5',
],
],
[
'name' => 'EffectiveScopes',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '生效范围列表',
'type' => 'array',
'items' => [
'description' => '内置权威域名zone生效范围',
'type' => 'object',
'properties' => [
'EffectiveType' => [
'description' => '生效范围类型'."\n"
.'account: 账户',
'type' => 'string',
'required' => false,
'example' => 'account',
],
'Scope' => [
'description' => '生效范围列表,与生效类型对应 account类型对应递归解析用户的accountid列表',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'required' => false,
'example' => '[20003]',
],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'description' => '排序字段,结果按哪个字段进行排序'."\n"
.'UpdateTime:修改时间'."\n"
.'RecordCount:解析记录条数'."\n",
'type' => 'string',
'required' => false,
'example' => 'default',
],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'description' => '排序方向'."\n"
.'asc:升序'."\n"
.'desc:降序',
'type' => 'string',
'required' => false,
'example' => 'asc',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '分批次查询时每次显示的条目数。取值范围:**1**~**100**,默认值为**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '50',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '下一个查询开始Token。',
'type' => 'string',
'required' => false,
'example' => '4698691',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时每页设置的大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '123',
],
'TotalItems' => [
'description' => '实例总条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'Zones' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Zone' => [
'description' => '域名zone列表',
'type' => 'array',
'items' => [
'description' => '可用区的集合。',
'type' => 'object',
'properties' => [
'ZoneId' => [
'title' => 'zone ID',
'description' => 'Zone ID,Zone的唯一识别码。'."\n"
."\n",
'type' => 'string',
'example' => '169439170000011',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2022-10-17T06:13Z',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1749694625000',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2024-08-13T01:44Z',
],
'UpdateTimestamp' => [
'description' => '修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1639621006000',
],
'ZoneName' => [
'title' => 'zone名称',
'description' => 'zone名称',
'type' => 'string',
'example' => 'ixiqiu.cn',
],
'Remark' => [
'title' => '备注',
'description' => '备注',
'type' => 'string',
'example' => '107',
],
'RecordCount' => [
'description' => '域名zone下的解析记录条数',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'ProxyPattern' => [
'title' => '代理模式',
'description' => '是否开启子域名递归代理。取值:'."\n"
."\n"
.'zone: 关闭(当解析本域名下不存在的子域名时,直接返回NXDOMAIN,表示子域名不存在)'."\n"
.'record: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)',
'type' => 'string',
'example' => 'record',
],
'Creator' => [
'title' => '创建者 id',
'description' => '创建者 id',
'type' => 'string',
'example' => '***',
],
'CreatorType' => [
'title' => '创建者类型',
'description' => '创建者类型,说明'."\n"
.'user:用户'."\n"
.'system:系统',
'type' => 'string',
'example' => 'USER',
],
'CreatorSubType' => [
'title' => '创建者子类型',
'description' => '账号类型。说明:'."\n"
."\n"
.'CUSTOMER:主账号'."\n"
.'SUB:子账号'."\n"
.'STS:角色扮演'."\n"
.'OTHER:其他'."\n",
'type' => 'string',
'example' => 'SUB',
],
'EffectiveScopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'EffectiveScope' => [
'title' => '解析范围',
'description' => '解析范围',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EffectiveType' => [
'title' => '解析范围类型',
'description' => '生效范围类型'."\n"
.'account 账户',
'type' => 'string',
'example' => 'account',
],
'Scopes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Scope' => [
'description' => '生效范围列表,与生效类型对应'."\n"
.'account类型对应递归解析用户的accountid列表',
'example' => '[20003]',
'type' => 'array',
'items' => [
'description' => '生效范围',
'type' => 'string',
'example' => '20003',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'MaxResults' => [
'description' => '分批次查询时每次显示的条目数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'NextToken' => [
'description' => '下一个查询开始Token。',
'type' => 'string',
'example' => '4698691',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 123,\\n \\"TotalItems\\": 11,\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"169439170000011\\",\\n \\"CreateTime\\": \\"2022-10-17T06:13Z\\",\\n \\"CreateTimestamp\\": 1749694625000,\\n \\"UpdateTime\\": \\"2024-08-13T01:44Z\\",\\n \\"UpdateTimestamp\\": 1639621006000,\\n \\"ZoneName\\": \\"ixiqiu.cn\\",\\n \\"Remark\\": \\"107\\",\\n \\"RecordCount\\": 20,\\n \\"ProxyPattern\\": \\"record\\",\\n \\"Creator\\": \\"***\\",\\n \\"CreatorType\\": \\"USER\\",\\n \\"CreatorSubType\\": \\"SUB\\",\\n \\"EffectiveScopes\\": {\\n \\"EffectiveScope\\": [\\n {\\n \\"EffectiveType\\": \\"account\\",\\n \\"Scopes\\": {\\n \\"Scope\\": [\\n \\"20003\\"\\n ]\\n }\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"4698691\\"\\n}","type":"json"}]',
'title' => '搜索HTTPDNS内置权威域名zone',
'description' => '- 请求中至少指定参数ResourceId.N或Tag.N(Tag.N.Key与Tag.N.Value),以确定检索对象。'."\n"
.'- Tag.N是资源的标签,由一个键值对组成。仅指定Tag.N.Key时,则返回该标签键关联的所有标签值。仅指定Tag.N.Value会报错。'."\n"
.'- 如果您同时指定Tag.N和ResourceId.N筛选标签,则ResourceId.N必须满足所有输入的标签键值对。'."\n"
.'- 如果您同时指定多个标签键值对,返回结果为同时包含被指定的多个键值对的资源。',
],
'UpdateRecursionZoneEffectiveScope' => [
'summary' => '修改HTTPDNS内置权威域名zone生效范围',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '21079fa016944979537637959d09bc'."\n",
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'title' => 'zone id',
'description' => 'Zone ID,Zone的唯一识别码。',
'type' => 'string',
'required' => false,
'example' => '173671468000011',
'pattern' => '^\\d+$',
],
],
[
'name' => 'EffectiveScopes',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '启用状态',
'description' => '生效范围列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EffectiveType' => [
'description' => '生效范围类型'."\n"
.'*account: 账户*',
'type' => 'string',
'required' => false,
'example' => 'account',
],
'Scope' => [
'description' => '生效范围列表,与生效类型对应 account类型对应递归解析用户的accountid列表',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382'."\n",
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\\\n\\"\\n}","type":"json"}]',
'title' => '修改HTTPDNS内置权威域名zone生效范围',
],
'UpdateRecursionZoneRemark' => [
'summary' => '修改HTTPDNS内置权威域名zone备注',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '21079fa016944979537637959d09bc',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'title' => 'zone id',
'description' => 'Zone ID,Zone的唯一识别码。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => '173671468000011',
'pattern' => '^\\d+$',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'title' => '备注',
'description' => '备注',
'type' => 'string',
'required' => false,
'example' => '备注',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\"\\n}","type":"json"}]',
'title' => '修改HTTPDNS内置权威域名zone备注',
'description' => '每个IP段的IP地址必须满足: EndIp >=StartIp。
'."\n"
.'域名下所有自定义线路中的所有IP段,IP范围都不能交叉重叠。',
],
'UpdateRecursionZoneProxyPattern' => [
'summary' => '修改HTTPDNS内置权威域名zone递归代理模式',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '21079fa016944979537637959d09bc',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'title' => 'zone id',
'description' => 'Zone ID,Zone的唯一识别码。',
'type' => 'string',
'required' => false,
'example' => '173671468000011',
'pattern' => '^\\d+$',
],
],
[
'name' => 'ProxyPattern',
'in' => 'query',
'schema' => [
'title' => '递归解析代理状态',
'description' => '是否开启子域名递归代理。取值:'."\n"
."\n"
.'zone: 关闭(当解析本域名下不存在的子域名时,直接返回NXDOMAIN,表示子域名不存在)'."\n"
.'record: 开启(当解析本域名下不存在的子域名时,会依次查询“转发”和“递归”模块,并以最终查询到的解析结果来应答解析请求)',
'type' => 'string',
'required' => false,
'example' => 'record',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\"\\n}","type":"json"}]',
'title' => '修改HTTPDNS内置权威域名zone递归代理模式',
'description' => '每个IP段的IP地址必须满足: EndIp >=StartIp。
'."\n"
.'域名下所有自定义线路中的所有IP段,IP范围都不能交叉重叠。',
],
'AddRecursionRecord' => [
'summary' => '新增递归解析内置权威解析记录。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '243563',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户端IP。',
'type' => 'string',
'required' => false,
'example' => '192.168.0.1',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => 'Zone ID。',
'type' => 'string',
'required' => false,
'example' => '173671468000011',
'pattern' => '^\\d+$',
],
],
[
'name' => 'Rr',
'in' => 'query',
'schema' => [
'description' => '主机记录。主机记录就是域名前缀,常见用法有www、@、*(泛解析)、mail(常用于邮箱)。'."\n"
."\n"
.'例如要解析@.exmaple.com,主机记录要填写"@”,而不是空。',
'type' => 'string',
'required' => false,
'example' => 'www',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '解析记录类型,目前支持如下: A:IPV4记录,支持将域名映射到IPv4地址使用 AAAA:IPV6记录,支持将域名映射到IPv6地址使用 CNAME:别名记录,支持将域名指向另外一个域名 MX:电邮交互记录,支持将域名指向邮件服务器地址 TXT:文本记录,是任意可读的文本DNS记录 SRV:服务器资源记录,用来标识某台服务器使用了某个服务,常见于微软系统的目录管理 NS:名称服务器记录,支持将子域名委托给其他DNS服务商解析 CAA:CAA资源记录,可以限定域名颁发证书和CA(证书颁发机构)之间的联系 URL:将域名指向另外一个已经存在的站点 SVCB:服务绑定记录,主要用于服务发现,以DNS记录的方式披露服务支持的协议和服务参数信息 HTTPS:针对HTTPS服务的特定记录类型,使用HTTPS记录,可约定安全的HTTPS建连协议,以及最优的服务站点地址',
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
[
'name' => 'RequestSource',
'in' => 'query',
'schema' => [
'description' => '解析线路,默认为**default**。参见:'."\n"
."\n"
.'[解析线路枚举](https://help.aliyun.com/document_detail/29807.html)'."\n"
."\n"
.'[解析线路枚举](https://www.alibabacloud.com/help/zh/doc-detail/29807.htm)',
'type' => 'string',
'required' => false,
'example' => 'default',
],
],
[
'name' => 'Weight',
'in' => 'query',
'schema' => [
'description' => '权重值(1-100 内的整数,包括 1 和 100,默认为1),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'description' => 'MX记录的优先级。取值越小,优先级越高,取值范围:[1,99]。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => [
'description' => '本地缓存时间。目前取值仅支持5、30、60、3600(1小时)、43200(12小时)、86400(24小时),单位秒(s),默认60。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => [
'description' => '记录值。根据不同解析记录类型,填写相应的记录值。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => '1.1.1.1',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '6447728c8578e66aacf062d2df4446dc'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '29D0F8F8-5499-4F6C-9FDC-1EE13BF55925',
],
'Success' => [
'description' => '本次操作是否成功:'."\n"
."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
'RecordId' => [
'description' => '解析记录的ID。',
'type' => 'string',
'example' => '173671468000010',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29D0F8F8-5499-4F6C-9FDC-1EE13BF55925\\",\\n \\"Success\\": true,\\n \\"RecordId\\": \\"173671468000010\\"\\n}","type":"json"}]',
'title' => '新增HTTPDNS内置权威解析记录',
'description' => '- 查询可以指定域名(DomainName)、页码(PageNumber)和每页的数量(PageSize)来获取域名的解析列表。'."\n"
.'- 查询可以指定解析记录的主机记录关键字(RRKeyWord)、解析类型关键字(TypeKeyWord)或者记录值的关键字(ValueKeyWord)来查询含有该关键字的解析列表。'."\n"
.'- 解析列表的默认排序方式是按照解析添加的时间从新到旧排序的。'."\n"
.'- 可以指定域名分组的ID(GroupId),全部域名代表所有域名、默认分组代表未设置分组的域名。',
],
'DescribeRecursionRecord' => [
'summary' => '查询HTTPDNS内置权威解析记录详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '解析记录id,解析记录的唯一标识',
'type' => 'string',
'required' => false,
'example' => '1917628665627259904',
'pattern' => '^\\d+$',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'ZoneId' => [
'title' => 'zone ID',
'description' => 'zone ID',
'type' => 'string',
'example' => '172635074000011',
],
'RecordId' => [
'title' => 'record ID',
'description' => 'record ID',
'type' => 'string',
'example' => '1903634198947606528',
],
'Rr' => [
'title' => '解析记录名称',
'description' => '主机记录',
'type' => 'string',
'example' => 'test',
],
'Type' => [
'title' => '解析记录类型',
'description' => '解析记录类型',
'type' => 'string',
'example' => 'A',
],
'Value' => [
'title' => '解析记录值',
'description' => '解析记录值',
'type' => 'string',
'example' => '1.1.XX.XX',
],
'Weight' => [
'title' => '权重',
'description' => '权重',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Ttl' => [
'title' => 'ttl',
'description' => 'ttl',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Priority' => [
'title' => 'ttl',
'description' => 'MX记录的优先级',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Remark' => [
'title' => '解析记录值',
'description' => '备注',
'type' => 'string',
'example' => 'test',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2024-03-23T13:09Z',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2024-03-29T13:20Z',
],
'UpdateTimestamp' => [
'description' => '更新时间(时间戳)',
'type' => 'integer',
'format' => 'int64',
'example' => '1527690629357',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"ZoneId\\": \\"172635074000011\\",\\n \\"RecordId\\": \\"1903634198947606528\\",\\n \\"Rr\\": \\"test\\",\\n \\"Type\\": \\"A\\",\\n \\"Value\\": \\"1.1.XX.XX\\",\\n \\"Weight\\": 2,\\n \\"Ttl\\": 60,\\n \\"Priority\\": 1,\\n \\"Remark\\": \\"test\\",\\n \\"CreateTime\\": \\"2024-03-23T13:09Z\\",\\n \\"CreateTimestamp\\": 1527690629357,\\n \\"UpdateTime\\": \\"2024-03-29T13:20Z\\",\\n \\"UpdateTimestamp\\": 1527690629357\\n}","type":"json"}]',
'title' => '查询HTTPDNS内置权威解析记录详情',
],
'UpdateRecursionRecord' => [
'summary' => '修改HTTPDNS内置权威解析记录',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '21079fa016944979537637959d09bc',
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '解析记录的ID。',
'type' => 'string',
'required' => false,
'example' => '9*******',
'pattern' => '^\\d+$',
],
],
[
'name' => 'Rr',
'in' => 'query',
'schema' => [
'title' => '解析记录名称',
'description' => '主机记录。主机记录就是域名前缀,常见用法有www、@、*(泛解析)、mail(常用于邮箱)。'."\n"
."\n"
.'例如要解析@.exmaple.com,主机记录要填写"@”,而不是空。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '解析记录类型',
'description' => '解析记录类型,目前支持如下: A:IPV4记录,支持将域名映射到IPv4地址使用 AAAA:IPV6记录,支持将域名映射到IPv6地址使用 CNAME:别名记录,支持将域名指向另外一个域名 MX:电邮交互记录,支持将域名指向邮件服务器地址 TXT:文本记录,是任意可读的文本DNS记录 SRV:服务器资源记录,用来标识某台服务器使用了某个服务,常见于微软系统的目录管理',
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
[
'name' => 'RequestSource',
'in' => 'query',
'schema' => [
'title' => '请求来源',
'description' => '解析线路,默认为**default**。参见:'."\n"
."\n"
.'[解析线路枚举](https://help.aliyun.com/document_detail/29807.html)'."\n"
."\n"
.'[解析线路枚举](https://www.alibabacloud.com/help/zh/doc-detail/29807.htm)',
'type' => 'string',
'required' => false,
'example' => 'WebSDK',
],
],
[
'name' => 'Weight',
'in' => 'query',
'schema' => [
'title' => '权重',
'description' => '权重值(1-100 内的整数,包括 1 和 100,默认为1),支持对每个地址设置不同的权重值,实现解析查询按照权重比例返回地址。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'Priority',
'in' => 'query',
'schema' => [
'title' => '优先级',
'description' => 'MX记录的优先级。取值越小,优先级越高,取值范围:[1,99]。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => [
'title' => 'ttl',
'description' => '本地缓存时间。目前取值仅支持5、30、60、3600(1小时)、43200(12小时)、86400(24小时),单位秒(s),默认60。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => [
'title' => '解析记录值',
'description' => '记录值。根据不同解析记录类型,填写相应的记录值。',
'type' => 'string',
'required' => false,
'example' => '1.1.XX.XX',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'RecordId' => [
'description' => '解析记录的ID。',
'type' => 'string',
'example' => '12*****',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"RecordId\\": \\"12*****\\"\\n}","type":"json"}]',
'title' => '修改HTTPDNS内置权威解析记录',
'description' => '如果被删除的解析记录中存在锁定解析,则该锁定解析不会被删除。',
],
'ListRecursionRecords' => [
'summary' => '查询HTTPDNS内置权威解析记录',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '241160',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '解析记录对应的ZoneId',
'type' => 'string',
'required' => false,
'example' => '17832322323',
'pattern' => '^\\d+$',
],
],
[
'name' => 'Rr',
'in' => 'query',
'schema' => [
'description' => '主机记录',
'type' => 'string',
'required' => false,
'example' => 'www',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '解析记录类型,目前支持如下: A:IPV4记录,支持将域名映射到IPv4地址使用 AAAA:IPV6记录,支持将域名映射到IPv6地址使用 CNAME:别名记录,支持将域名指向另外一个域名 MX:电邮交互记录,支持将域名指向邮件服务器地址 TXT:文本记录,是任意可读的文本DNS记录 SRV:服务器资源记录,用来标识某台服务器使用了某个服务,常见于微软系统的目录管理',
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
[
'name' => 'Weight',
'in' => 'query',
'schema' => [
'description' => '解析记录权重 0-100',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RequestSource',
'in' => 'query',
'schema' => [
'description' => '解析线路,默认为**default**。参见:'."\n"
."\n"
.'[解析线路枚举](https://help.aliyun.com/document_detail/29807.html)'."\n"
."\n"
.'[解析线路枚举](https://www.alibabacloud.com/help/zh/doc-detail/29807.htm)',
'type' => 'string',
'required' => false,
'example' => 'default',
],
],
[
'name' => 'Enable',
'in' => 'query',
'schema' => [
'description' => '解析记录启用状态,**enable:启用 disable:禁用**',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => [
'description' => '本地缓存时间。目前取值仅支持5、30、60、3600(1小时)、43200(12小时)、86400(24小时),单位秒(s),默认60。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注',
'type' => 'string',
'required' => false,
'example' => 'remark',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '下一个查询开始Token。',
'type' => 'string',
'required' => false,
'example' => '4698691',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '本次请求所返回的最大记录条数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B'."\n",
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPages' => [
'description' => '总页数',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalItems' => [
'description' => '总记录条数',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'Records' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Record' => [
'description' => '解析记录列表',
'type' => 'array',
'items' => [
'description' => '解析记录',
'type' => 'object',
'properties' => [
'ZoneId' => [
'title' => 'zone ID',
'description' => '解析记录对应的ZoneId',
'type' => 'string',
'example' => '169439170000011',
],
'RecordId' => [
'title' => 'record ID',
'description' => '解析记录ID,解析记录的唯一标识',
'type' => 'string',
'example' => '1897105298264316928',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2023-06-28T09:16Z',
],
'CreateTimestamp' => [
'description' => '创建时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1721119172000',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2024-10-22T09:54Z',
],
'UpdateTimestamp' => [
'description' => '修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1620283051000',
],
'Rr' => [
'title' => 'record 名称',
'description' => '主机记录',
'type' => 'string',
'example' => 'wap',
],
'Type' => [
'title' => 'record 类型',
'description' => '解析记录类型',
'type' => 'string',
'example' => 'A',
],
'Ttl' => [
'title' => 'ttl',
'description' => '解析记录ttl',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Priority' => [
'title' => '优先级',
'description' => 'MX记录的优先级',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Value' => [
'title' => '解析记录值',
'description' => '解析记录值',
'type' => 'string',
'example' => '120.38.70.54',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '启用状态',
'type' => 'string',
'example' => 'enable',
],
'Remark' => [
'title' => '备注',
'description' => '备注',
'type' => 'string',
'example' => '1150',
],
'RequestSource' => [
'title' => '请求来源',
'description' => '请求来源',
'type' => 'string',
'example' => 'default',
],
'Weight' => [
'description' => '解析记录权重',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Creator' => [
'title' => '创建者',
'description' => '创建者ID',
'type' => 'integer',
'format' => 'int64',
'example' => '123121312',
],
'CreatorType' => [
'title' => '创建者类型',
'description' => '创建者类型 user用户,system系统',
'type' => 'string',
'example' => 'user',
],
'CreatorSubType' => [
'title' => '创建者子类型',
'description' => '账号类型。说明:'."\n"
."\n"
.'custom:主账号 sub:子账号 sts:角色扮演 other:其他',
'type' => 'string',
'example' => 'custom',
],
],
],
],
],
],
'MaxResults' => [
'description' => '本次请求所返回的最大记录条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '500',
],
'NextToken' => [
'description' => '下一个查询开始Token。',
'type' => 'string',
'example' => '4698691',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\\\n\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalPages\\": 5,\\n \\"TotalItems\\": 100,\\n \\"Records\\": {\\n \\"Record\\": [\\n {\\n \\"ZoneId\\": \\"169439170000011\\",\\n \\"RecordId\\": \\"1897105298264316928\\",\\n \\"CreateTime\\": \\"2023-06-28T09:16Z\\",\\n \\"CreateTimestamp\\": 1721119172000,\\n \\"UpdateTime\\": \\"2024-10-22T09:54Z\\",\\n \\"UpdateTimestamp\\": 1620283051000,\\n \\"Rr\\": \\"wap\\",\\n \\"Type\\": \\"A\\",\\n \\"Ttl\\": 60,\\n \\"Priority\\": 10,\\n \\"Value\\": \\"120.38.70.54\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"Remark\\": \\"1150\\",\\n \\"RequestSource\\": \\"default\\",\\n \\"Weight\\": 1,\\n \\"Creator\\": 123121312,\\n \\"CreatorType\\": \\"user\\",\\n \\"CreatorSubType\\": \\"custom\\"\\n }\\n ]\\n },\\n \\"MaxResults\\": 500,\\n \\"NextToken\\": \\"4698691\\"\\n}","type":"json"}]',
'title' => '查询HTTPDNS内置权威解析记录',
],
'DeleteRecursionRecord' => [
'summary' => '删除HTTPDNS内置权威解析记录',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
[
'BearerToken' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'description' => '解析记录id,解析记录的唯一标识',
'type' => 'string',
'required' => false,
'example' => '17432432424',
'pattern' => '^\\d+$',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '21079fa016944979537637959d09bc',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B'."\n",
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\\\n\\"\\n}","type":"json"}]',
'title' => '删除HTTPDNS内置权威解析记录',
],
'SearchRecursionRecords' => [
'summary' => '搜索HTTPDNS内置权威解析记录',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'description' => '解析记录对应的ZoneId',
'type' => 'string',
'required' => false,
'example' => '169438909000011',
'pattern' => '^\\d+$',
],
],
[
'name' => 'Rr',
'in' => 'query',
'schema' => [
'description' => '主机记录',
'type' => 'string',
'required' => false,
'example' => 'www',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '解析记录类型,目前支持如下: A:IPV4记录,支持将域名映射到IPv4地址使用 AAAA:IPV6记录,支持将域名映射到IPv6地址使用 CNAME:别名记录,支持将域名指向另外一个域名 MX:电邮交互记录,支持将域名指向邮件服务器地址 TXT:文本记录,是任意可读的文本DNS记录 SRV:服务器资源记录,用来标识某台服务器使用了某个服务,常见于微软系统的目录管理',
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
[
'name' => 'Weight',
'in' => 'query',
'schema' => [
'description' => '解析记录权重 0-100',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'RequestSource',
'in' => 'query',
'schema' => [
'description' => '解析线路,默认为**default**。参见:'."\n"
."\n"
.'[解析线路枚举](https://help.aliyun.com/document_detail/29807.html)'."\n"
."\n"
.'[解析线路枚举](https://www.alibabacloud.com/help/zh/doc-detail/29807.htm)',
'type' => 'string',
'required' => false,
'example' => 'default',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'description' => '解析记录启用状态,**enable:启用,disable:禁用**',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
[
'name' => 'Ttl',
'in' => 'query',
'schema' => [
'description' => '本地缓存时间。目前取值仅支持5、30、60、3600(1小时)、43200(12小时)、86400(一天),单位秒(s),默认60。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '60',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => [
'description' => '记录值',
'type' => 'string',
'required' => false,
'example' => '1.1.XX.XX',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'description' => '排序方式:'."\n"
.'支持rr/type/value/requestSource/weight/ttl/enableStatus',
'type' => 'string',
'required' => false,
'example' => 'rr',
],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'description' => '排序方向,asc为生序,dsc为降序。',
'type' => 'string',
'required' => false,
'example' => 'asc',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'MaxResults',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '本次请求所返回的最大记录条数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '下一个查询开始Token。',
'type' => 'string',
'required' => false,
'example' => '4698691',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'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' => [
'ZoneId' => [
'title' => 'zone ID',
'description' => 'zone ID',
'type' => 'string',
'example' => '169783221000012',
],
'RecordId' => [
'title' => 'record ID',
'description' => 'record ID',
'type' => 'string',
'example' => '1927184083990351872',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2025-06-16T02:18Z',
],
'CreateTimestamp' => [
'description' => '创建时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1615182315000',
],
'UpdateTime' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2022-10-28T13:07Z',
],
'UpdateTimestamp' => [
'description' => '修改时间(时间戳)。',
'type' => 'integer',
'format' => 'int64',
'example' => '1722107570000',
],
'Rr' => [
'title' => 'record 名称',
'description' => '主机记录',
'type' => 'string',
'example' => 'wap',
],
'Type' => [
'title' => 'record 类型',
'description' => '解析记录类型',
'type' => 'string',
'example' => 'A',
],
'Ttl' => [
'title' => 'ttl',
'description' => '解析记录ttl',
'type' => 'integer',
'format' => 'int32',
'example' => '60',
],
'Priority' => [
'title' => '优先级',
'description' => 'MX记录优先级',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Value' => [
'title' => '解析记录值',
'description' => '解析记录值',
'type' => 'string',
'example' => '14.19.85.71',
],
'EnableStatus' => [
'title' => '启用状态',
'description' => '启用状态,**enable:启用,disable:禁用**',
'type' => 'string',
'example' => 'enable',
],
'Remark' => [
'title' => '备注',
'description' => '备注',
'type' => 'string',
'example' => 'vxwk',
],
'RequestSource' => [
'title' => '请求来源',
'description' => '请求来源',
'type' => 'string',
'example' => 'default',
],
'Weight' => [
'title' => '权重',
'description' => '权重',
'type' => 'string',
'example' => '4',
],
'Creator' => [
'title' => '创建者',
'description' => '创建者ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1521021611066866',
],
'CreatorType' => [
'title' => '创建者类型',
'description' => '创建者类型 user用户,system系统',
'type' => 'string',
'example' => 'user',
],
'CreatorSubType' => [
'title' => '创建者子类型',
'description' => '账号类型。说明:'."\n"
."\n"
.'custom:主账号 sub:子账号 sts:角色扮演 other:其他',
'type' => 'string',
'example' => 'custom',
],
],
],
],
],
],
'MaxResults' => [
'description' => '本次请求所返回的最大记录条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '500',
],
'NextToken' => [
'description' => '下一个查询开始Token。',
'type' => 'string',
'example' => '4698691',
],
],
],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 100,\\n \\"Records\\": {\\n \\"Record\\": [\\n {\\n \\"ZoneId\\": \\"169783221000012\\",\\n \\"RecordId\\": \\"1927184083990351872\\",\\n \\"CreateTime\\": \\"2025-06-16T02:18Z\\",\\n \\"CreateTimestamp\\": 1615182315000,\\n \\"UpdateTime\\": \\"2022-10-28T13:07Z\\",\\n \\"UpdateTimestamp\\": 1722107570000,\\n \\"Rr\\": \\"wap\\",\\n \\"Type\\": \\"A\\",\\n \\"Ttl\\": 60,\\n \\"Priority\\": 1,\\n \\"Value\\": \\"14.19.85.71\\",\\n \\"EnableStatus\\": \\"enable\\",\\n \\"Remark\\": \\"vxwk\\",\\n \\"RequestSource\\": \\"default\\",\\n \\"Weight\\": \\"4\\",\\n \\"Creator\\": 1521021611066866,\\n \\"CreatorType\\": \\"user\\",\\n \\"CreatorSubType\\": \\"custom\\"\\n }\\n ]\\n },\\n \\"MaxResults\\": 500,\\n \\"NextToken\\": \\"4698691\\"\\n}","type":"json"}]',
'title' => '搜索HTTPDNS内置权威解析记录',
],
'UpdateRecursionRecordEnableStatus' => [
'summary' => '修改HTTPDNS内置权威解析记录启用状态',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '21079fa016944979537637959d09bc',
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'title' => '解析记录id',
'description' => '解析记录id,解析记录的唯一标识',
'type' => 'string',
'required' => false,
'example' => '1781234321',
'pattern' => '^\\d+$',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'title' => '启用状态',
'description' => '启用状态,**enable:启用 disable:禁用**',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B'."\n",
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\\\n\\"\\n}","type":"json"}]',
'title' => '修改HTTPDNS内置权威解析记录启用状态',
],
'UpdateRecursionRecordWeight' => [
'summary' => '修改HTTPDNS内置权威解析记录权重',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '243565',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '21079fa016944979537637959d09bc',
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'title' => '解析记录id',
'description' => '解析记录id,解析记录的唯一标识',
'type' => 'string',
'required' => false,
'example' => '17363242424',
'pattern' => '^\\d+$',
],
],
[
'name' => 'Weight',
'in' => 'query',
'schema' => [
'title' => '权重',
'description' => '权重 支持0-100',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B'."\n",
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\\\n\\"\\n}","type":"json"}]',
'title' => '修改HTTPDNS内置权威解析记录权重',
],
'UpdateRecursionRecordWeightEnableStatus' => [
'summary' => '修改递归解析内置权威解析记录权重算法启用状态',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '客户端Token,用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符。',
'type' => 'string',
'required' => false,
'example' => '21079fa016944979537637959d09bc',
],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => [
'title' => 'zone id',
'description' => 'zone id,解析记录对应的域名ZoneId',
'type' => 'string',
'required' => false,
'example' => '176432424234',
'pattern' => '^\\d+$',
],
],
[
'name' => 'Rr',
'in' => 'query',
'schema' => [
'title' => '解析记录名称',
'description' => '主机记录',
'type' => 'string',
'required' => false,
'example' => 'www',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'title' => '解析记录类型',
'description' => '解析记录类型,目前支持如下: A:IPV4记录,支持将域名映射到IPv4地址使用 AAAA:IPV6记录,支持将域名映射到IPv6地址使用 CNAME:别名记录,支持将域名指向另外一个域名 MX:电邮交互记录,支持将域名指向邮件服务器地址 TXT:文本记录,是任意可读的文本DNS记录 SRV:服务器资源记录,用来标识某台服务器使用了某个服务,常见于微软系统的目录管理',
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
[
'name' => 'RequestSource',
'in' => 'query',
'schema' => [
'title' => '请求来源',
'description' => '解析线路,默认为**default**。参见:'."\n"
."\n"
.'[解析线路枚举](https://help.aliyun.com/document_detail/29807.html)'."\n"
."\n"
.'[解析线路枚举](https://www.alibabacloud.com/help/zh/doc-detail/29807.htm)',
'type' => 'string',
'required' => false,
'example' => 'default',
],
],
[
'name' => 'EnableStatus',
'in' => 'query',
'schema' => [
'title' => '启用状态',
'description' => '是否开启权重,enable:开启,disable:关闭',
'type' => 'string',
'required' => false,
'example' => 'enable',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B'."\n",
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\\\n\\"\\n}","type":"json"}]',
'title' => '修改HTTPDNS内置权威解析记录权重算法启用状态',
],
'UpdateRecursionRecordRemark' => [
'summary' => '修改HTTPDNS内置权威解析记录备注',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns379HH9',
],
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => 'e432232342423ew423',
],
],
[
'name' => 'RecordId',
'in' => 'query',
'schema' => [
'title' => 'record id',
'description' => 'record id',
'type' => 'string',
'required' => false,
'example' => '173671468000010',
'pattern' => '^\\d+$',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'title' => '备注',
'description' => '备注',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\"\\n}","type":"json"}]',
'title' => '修改HTTPDNS内置权威解析记录备注',
],
'DescribeDohAccountStatistics' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2019-07-04',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2019-07-04',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => '0F32959D-417B-4D66-8463-68606605E3E2',
],
'Statistics' => [
'description' => '统计数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'V6HttpCount' => [
'description' => 'IPv6 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpsCount' => [
'description' => 'IPv4 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'Timestamp' => [
'description' => '统计时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1544976000000',
],
'TotalCount' => [
'description' => '请求总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpCount' => [
'description' => 'IPv4 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V6HttpsCount' => [
'description' => 'IPv6 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F32959D-417B-4D66-8463-68606605E3E2\\",\\n \\"Statistics\\": [\\n {\\n \\"V6HttpCount\\": 3141592653,\\n \\"V4HttpsCount\\": 3141592653,\\n \\"Timestamp\\": 1544976000000,\\n \\"TotalCount\\": 3141592653,\\n \\"V4HttpCount\\": 3141592653,\\n \\"V6HttpsCount\\": 3141592653\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 0F32959D-417B-4D66-8463-68606605E3E2\\n \\n 3141592653\\n 3141592653\\n 1544976000000\\n 3141592653\\n 3141592653\\n 3141592653\\n \\n","errorExample":""}]',
'title' => '获取DoH账户请求量统计概览',
'summary' => '获取DoH账户请求量统计概览。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDohDomainStatistics' => [
'summary' => '获取DoH域名请求量统计概览。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdns5Q9UHE',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2019-07-04',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2019-07-04',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0F32959D-417B-4D66-8463-68606605E3E2',
],
'Statistics' => [
'description' => '统计数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'V6HttpCount' => [
'description' => 'IPv6 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpsCount' => [
'description' => 'IPv4 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'Timestamp' => [
'description' => '统计时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1544976000000',
],
'TotalCount' => [
'description' => '请求总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpCount' => [
'description' => 'IPv4 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V6HttpsCount' => [
'description' => 'IPv6 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F32959D-417B-4D66-8463-68606605E3E2\\",\\n \\"Statistics\\": [\\n {\\n \\"V6HttpCount\\": 3141592653,\\n \\"V4HttpsCount\\": 3141592653,\\n \\"Timestamp\\": 1544976000000,\\n \\"TotalCount\\": 3141592653,\\n \\"V4HttpCount\\": 3141592653,\\n \\"V6HttpsCount\\": 3141592653\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0F32959D-417B-4D66-8463-68606605E3E2\\n\\n 3141592653\\n 3141592653\\n 3141592653\\n 1544976000000\\n 3141592653\\n 3141592653\\n","errorExample":""}]',
'title' => '获取DoH域名请求量统计概览',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDohDomainStatisticsSummary' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'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' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2019-07-04 ',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'example' => '2019-07-04 ',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0F32959D-417B-4D66-8463-68606605E3E2',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'TotalItems' => [
'description' => '总数据条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '300',
],
'Statistics' => [
'description' => '统计数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'V6HttpCount' => [
'description' => 'IPv6 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpsCount' => [
'description' => 'IPv4 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'IpCount' => [
'description' => 'IP地址数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'TotalCount' => [
'description' => '请求总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '14141592653',
],
'HttpCount' => [
'description' => 'HTTP请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'HttpsCount' => [
'description' => 'HTTPS请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpCount' => [
'description' => 'IPv4 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V6HttpsCount' => [
'description' => 'IPv6 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"0F32959D-417B-4D66-8463-68606605E3E2\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 50,\\n \\"TotalItems\\": 300,\\n \\"Statistics\\": [\\n {\\n \\"V6HttpCount\\": 3141592653,\\n \\"V4HttpsCount\\": 3141592653,\\n \\"IpCount\\": 20,\\n \\"TotalCount\\": 14141592653,\\n \\"HttpCount\\": 3141592653,\\n \\"DomainName\\": \\"example.com\\",\\n \\"HttpsCount\\": 3141592653,\\n \\"V4HttpCount\\": 3141592653,\\n \\"V6HttpsCount\\": 3141592653\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 20\\n 0F32959D-417B-4D66-8463-68606605E3E2\\n 1\\n 50\\n 300\\n \\n 3141592653\\n 3141592653\\n 20\\n 14141592653\\n 3141592653\\n example.com\\n 3141592653\\n 3141592653\\n 3141592653\\n \\n","errorExample":""}]',
'title' => '获取DoH域名的请求量统计列表',
'summary' => '获取DoH域名的请求量统计列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDohSubDomainStatistics' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'SubDomain',
'in' => 'query',
'schema' => [
'description' => '要查看统计数据的子域名',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'www.example.com',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2019-07-04',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2019-07-04',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0F32959D-417B-4D66-8463-68606605E3E2',
],
'Statistics' => [
'description' => '统计数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'V6HttpCount' => [
'description' => 'IPv6 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpsCount' => [
'description' => 'IPv4 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'Timestamp' => [
'description' => '统计时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1544976000000',
],
'TotalCount' => [
'description' => '请求总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpCount' => [
'description' => 'IPv4 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V6HttpsCount' => [
'description' => 'IPv6 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F32959D-417B-4D66-8463-68606605E3E2\\",\\n \\"Statistics\\": [\\n {\\n \\"V6HttpCount\\": 3141592653,\\n \\"V4HttpsCount\\": 3141592653,\\n \\"Timestamp\\": 1544976000000,\\n \\"TotalCount\\": 3141592653,\\n \\"V4HttpCount\\": 3141592653,\\n \\"V6HttpsCount\\": 3141592653\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0F32959D-417B-4D66-8463-68606605E3E2\\n\\n 3141592653\\n 3141592653\\n 3141592653\\n 1544976000000\\n 3141592653\\n 3141592653\\n","errorExample":""}]',
'title' => '获取DoH子域名请求量统计',
'summary' => '获取DoH子域名请求量统计。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDohSubDomainStatisticsSummary' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '20',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => ' '."\n"
.'查询的开始时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '2019-07-04 ',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => ' '."\n"
.'查询的结束时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'example' => '2019-07-04 ',
],
],
[
'name' => 'SubDomain',
'in' => 'query',
'schema' => [
'description' => '子域名。',
'type' => 'string',
'required' => false,
'example' => 'www.example.com',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0F32959D-417B-4D66-8463-68606605E3E2',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'TotalItems' => [
'description' => '总数据条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '100',
],
'Statistics' => [
'description' => '统计数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'V6HttpCount' => [
'description' => 'IPv6 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpsCount' => [
'description' => 'IPv4 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'IpCount' => [
'description' => 'IP地址数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '20',
],
'SubDomain' => [
'description' => '子域名。',
'type' => 'string',
'example' => 'www.example.com',
],
'TotalCount' => [
'description' => '总请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '14141592653',
],
'HttpCount' => [
'description' => 'HTTP请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'HttpsCount' => [
'description' => 'HTTPS请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V4HttpCount' => [
'description' => 'IPv4 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
'V6HttpsCount' => [
'description' => 'IPv6 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '3141592653',
],
],
],
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"0F32959D-417B-4D66-8463-68606605E3E2\\",\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 50,\\n \\"TotalItems\\": 100,\\n \\"Statistics\\": [\\n {\\n \\"V6HttpCount\\": 3141592653,\\n \\"V4HttpsCount\\": 3141592653,\\n \\"IpCount\\": 20,\\n \\"SubDomain\\": \\"www.example.com\\",\\n \\"TotalCount\\": 14141592653,\\n \\"HttpCount\\": 3141592653,\\n \\"HttpsCount\\": 3141592653,\\n \\"V4HttpCount\\": 3141592653,\\n \\"V6HttpsCount\\": 3141592653\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0F32959D-417B-4D66-8463-68606605E3E2\\n10\\n1\\n50\\n100\\n\\n www.example.com\\n 14141592653\\n 20\\n 3141592653\\n 3141592653\\n 3141592653\\n 3141592653\\n 3141592653\\n 3141592653\\n","errorExample":""}]',
'title' => '获取DoH子域名的请求量统计列表',
'summary' => '获取DoH子域名的请求量统计列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDohUserInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '语言。',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'只能查询最近90天的记录,即:`StartDate >= Now - 90`。',
'type' => 'string',
'required' => false,
'example' => '2019-07-04',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => ' '."\n"
.'查询的结束时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'example' => '2019-07-04',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0F32959D-417B-4D66-8463-68606605E3E2',
],
'SubDomainCount' => [
'description' => '已接入子域名数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'PdnsId' => [
'description' => '公共DNS用户ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12345678',
],
'DomainCount' => [
'description' => '已接入域名数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
],
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F32959D-417B-4D66-8463-68606605E3E2\\",\\n \\"SubDomainCount\\": 5,\\n \\"PdnsId\\": 12345678,\\n \\"DomainCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"0F32959D-417B-4D66-8463-68606605E3E2\\n123\\n12345678\\n123","errorExample":""}]',
'title' => '获取DoH用户基本信息',
'summary' => '获取DoH用户基本信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreatePdnsAppKey' => [
'summary' => '创建公共DNS密钥 AccessKey。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]',
'title' => '创建公共DNS密钥AccessKey ',
],
'RemovePdnsAppKey' => [
'summary' => '删除公共DNS AppKey',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AppKeyId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'DescribePdnsAppKey' => [
'summary' => '获取公共DNS AppKey 详情',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'AppKeyId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AuthCode',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'AppKey' => [
'type' => 'object',
'properties' => [
'AppKeyId' => [
'type' => 'string',
],
'AppKeySecret' => [
'type' => 'string',
],
'Remark' => [
'type' => 'string',
],
'State' => [
'type' => 'string',
],
'CreateDate' => [
'type' => 'string',
],
'CreateTimestamp' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
'responseDemo' => '',
],
'DescribePdnsAppKeys' => [
'summary' => '获取公共DNS AppKey 列表',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsBBR04Z',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'AppKeys' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AppKeyId' => [
'type' => 'string',
],
'CreateDate' => [
'type' => 'string',
],
'Remark' => [
'type' => 'string',
],
'State' => [
'type' => 'string',
],
'CreateTimestamp' => [
'type' => 'integer',
'format' => 'int64',
],
'BindEdgeDnsClusters' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClusterId' => [
'type' => 'string',
],
'ClusterName' => [
'type' => 'string',
],
'ClusterUserId' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '',
],
'UpdateAppKeyState' => [
'summary' => '修改 AppKey 状态',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'AppKeyId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'State',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'CreatePdnsUdpIpSegment' => [
'summary' => '创建公共DNS Udp Ip地址段',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IpToken',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'ValidMessage' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'ValidatePdnsUdpIpSegment' => [
'summary' => '验证公共DNS Udp Ip地址段',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
],
'parameters' => [
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'IpToken',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'DescribePdnsUdpIpSegments' => [
'summary' => '获取公共DNS Udp IP段列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalPages' => [
'type' => 'string',
],
'TotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int64',
],
'RequestId' => [
'type' => 'string',
],
'PageNumber' => [
'type' => 'integer',
'format' => 'int64',
],
'IpSegments' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Id' => [
'type' => 'string',
],
'Name' => [
'type' => 'string',
],
'Ip' => [
'type' => 'string',
],
'Mask' => [
'type' => 'integer',
'format' => 'int64',
],
'State' => [
'type' => 'string',
],
'SecretKey' => [
'type' => 'string',
],
'CreateDate' => [
'type' => 'string',
],
'UpdateDate' => [
'type' => 'string',
],
'CreateTimestamp' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
'responseDemo' => '',
],
'RemovePdnsUdpIpSegment' => [
'summary' => '删除公共DNS Udp Ip地址段',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Ip',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'DescribePdnsThreatStatistics' => [
'summary' => '获取公共DNS 威胁统计列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'SubDomain',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ThreatType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ThreatLevel',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ThreatSourceIp',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int64',
],
'RequestId' => [
'type' => 'string',
],
'PageNumber' => [
'type' => 'integer',
'format' => 'int64',
],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DomainName' => [
'type' => 'string',
],
'SubDomain' => [
'type' => 'string',
],
'LatestThreatTime' => [
'type' => 'integer',
'format' => 'int64',
],
'TotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'DohTotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'UdpTotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'MaxThreatLevel' => [
'type' => 'string',
],
'DomainCount' => [
'type' => 'integer',
'format' => 'int64',
],
'SourceIp' => [
'type' => 'string',
],
'ThreatType' => [
'type' => 'string',
],
'ThreatLevel' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'responseDemo' => '',
],
'DescribePdnsUserInfo' => [
'summary' => '获取公共DNS用户信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '16827',
'abilityTreeNodes' => [
'FEATUREdns6E2Y22',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => 'FD552816-FCC8-4832-B4A2-2DA0C2BA1688',
],
'UserInfo' => [
'description' => '用户信息',
'type' => 'object',
'properties' => [
'PdnsId' => [
'description' => '公网递归专属配置ID',
'type' => 'integer',
'format' => 'int64',
'example' => '1***1',
],
'State' => [
'description' => '公网递归服务状态',
'type' => 'string',
'example' => 'AVAILABLE',
],
'ServiceType' => [
'description' => '公网递归服务类型',
'type' => 'string',
'example' => 'normal',
],
'StoppedService' => [
'description' => '关闭的公网递归服务',
'type' => 'string',
],
'AvailableService' => [
'description' => '启用的公网递归服务',
'type' => 'string',
'example' => 'HTTP,HTTPS',
],
'StatisticSwitchStatus' => [
'description' => '公网递归流量分析开关状态',
'type' => 'string',
'example' => 'CLOSED',
],
'SecretKey' => [
'description' => 'UDP接入IP地址段配置SecretKey',
'type' => 'string',
'example' => '1c09*******',
],
'AvailableAccessSecurityType' => [
'description' => '启用的安全接入类型,INSECURE指非加密接入,SECURE指安全加密接入。',
'type' => 'string',
'example' => 'SECURE',
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FD552816-FCC8-4832-B4A2-2DA0C2BA1688\\",\\n \\"UserInfo\\": {\\n \\"PdnsId\\": 0,\\n \\"State\\": \\"AVAILABLE\\",\\n \\"ServiceType\\": \\"normal\\",\\n \\"StoppedService\\": \\"\\",\\n \\"AvailableService\\": \\"HTTP,HTTPS\\",\\n \\"StatisticSwitchStatus\\": \\"CLOSED\\",\\n \\"SecretKey\\": \\"1c09*******\\",\\n \\"AvailableAccessSecurityType\\": \\"SECURE\\"\\n }\\n}","type":"json"}]',
'title' => '获取公共DNS用户信息',
],
'DescribePdnsRequestStatistic' => [
'summary' => '查询公共DNS的请求量列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '16786',
'abilityTreeNodes' => [
'FEATUREdns5Q9UHE',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '要查看统计数据的主域名名称。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'SubDomain',
'in' => 'query',
'schema' => [
'description' => '要查看统计数据的子域名名称。',
'type' => 'string',
'required' => false,
'example' => 'www.example.com',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '请求量统计类型:'."\n"
.'- **ACCOUNT**:按照账户维度查看请求量统计;'."\n"
.'- **DOMAIN**:按照域名维度查看请求量统计;此时,DomainName必填'."\n"
.'- **SUB_DOMAIN**:按照子域名维度查看请求量统计;此时,DomainName和SubDomain必填',
'type' => 'string',
'required' => false,
'example' => 'ACCOUNT',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:**YYYY-MM-DD**。'."\n"
."\n"
.'只能查询最近90天的记录。',
'type' => 'string',
'required' => false,
'example' => '2024-06-14',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:**YYYY-MM-DD**。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'example' => '2024-07-01',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Data' => [
'description' => '请求量数据列表。',
'type' => 'array',
'items' => [
'description' => '请求量数据列表。',
'type' => 'object',
'properties' => [
'V6HttpCount' => [
'description' => 'IPv6 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'V6HttpsCount' => [
'description' => 'IPv6 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'Timestamp' => [
'description' => '统计时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1706716800000',
],
'TotalCount' => [
'description' => '请求总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'V4HttpCount' => [
'description' => 'IPv4 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'V4HttpsCount' => [
'description' => 'IPv4 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'V4Count' => [
'description' => 'IPv4请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'V6Count' => [
'description' => 'IPv6请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HttpCount' => [
'description' => 'HTTP请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HttpsCount' => [
'description' => 'HTTPS请求量。但在公共DNS控制台流量分析页签中,此参数版包含了DoH的请求量,所以DoH的请求量没有在控制台单独展示。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'DohTotalCount' => [
'description' => 'Doh总请求量,包含了HTTP和HTTPS请求总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'UdpTotalCount' => [
'description' => 'Udp总请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '5000',
],
'IpCount' => [
'description' => '源IP地址数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Data\\": [\\n {\\n \\"V6HttpCount\\": 0,\\n \\"V6HttpsCount\\": 0,\\n \\"Timestamp\\": 1706716800000,\\n \\"TotalCount\\": 0,\\n \\"V4HttpCount\\": 0,\\n \\"V4HttpsCount\\": 0,\\n \\"V4Count\\": 0,\\n \\"V6Count\\": 0,\\n \\"HttpCount\\": 0,\\n \\"HttpsCount\\": 0,\\n \\"DohTotalCount\\": 0,\\n \\"UdpTotalCount\\": 5000,\\n \\"IpCount\\": 10\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询公共DNS请求量统计数据',
],
'DescribePdnsThreatLogs' => [
'summary' => '获取公共DNS 威胁日志列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ThreatType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ThreatLevel',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ThreatSourceIp',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int64',
],
'RequestId' => [
'type' => 'string',
],
'PageNumber' => [
'type' => 'integer',
'format' => 'int64',
],
'Logs' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ThreatTime' => [
'type' => 'string',
],
'ThreatType' => [
'type' => 'string',
],
'ThreatLevel' => [
'type' => 'string',
],
'SourceIp' => [
'type' => 'string',
],
'SubDomain' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'responseDemo' => '',
],
'DescribePdnsRequestStatistics' => [
'summary' => '查询指定子域名请求量的统计数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '16787',
'abilityTreeNodes' => [
'FEATUREdns5Q9UHE',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '设置请求和接收消息的语言类型,默认为**zh**。取值:'."\n"
."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '需要查询的主域名名称。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'SubDomain',
'in' => 'query',
'schema' => [
'description' => '要查看统计数据的子域名名称。',
'type' => 'string',
'required' => false,
'example' => 'www.example.com',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'description' => '查询请求量统计类型:'."\n"
."\n"
.'- DOMAIN:按照域名维度查看请求量统计;'."\n"
."\n"
.'- SUB_DOMAIN:按照子域名维度查看请求量统计;',
'type' => 'string',
'required' => false,
'example' => 'DOMAIN',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'只能查询最近90天的记录。',
'type' => 'string',
'required' => false,
'example' => '2024-06-14',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间,格式:YYYY-MM-DD。'."\n"
."\n"
.'默认为查询当天的时间。',
'type' => 'string',
'required' => false,
'example' => '2024-07-14',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数,最大值100,默认为20。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '获取的总列表数。',
'type' => 'integer',
'format' => 'int64',
'example' => '49',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'RequestId' => [
'description' => '唯一请求识别码。'."\n"
."\n",
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'Data' => [
'description' => '请求量数据列表。',
'type' => 'array',
'items' => [
'description' => '请求量数据列表。',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'SubDomain' => [
'description' => '子域名名称。',
'type' => 'string',
'example' => 'www.example.com',
],
'V6HttpCount' => [
'description' => 'IPv6 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'V6HttpsCount' => [
'description' => 'IPv6 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'TotalCount' => [
'description' => '请求总量',
'type' => 'integer',
'format' => 'int64',
'example' => '500',
],
'V4HttpCount' => [
'description' => 'IPv4 HTTP 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'V4HttpsCount' => [
'description' => 'IPv4 HTTPS 请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'V4Count' => [
'description' => 'IPv4请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'V6Count' => [
'description' => 'IPv6请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HttpCount' => [
'description' => 'HTTP请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'HttpsCount' => [
'description' => 'HTTPS请求量。但在公共DNS控制台流量分析页签中,此参数版包含了DoH的请求量,所以DoH的请求量没有在控制台单独展示。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'DohTotalCount' => [
'description' => 'Doh总请求量。Doh总请求量,包含了HTTP和HTTPS请求总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '0',
],
'UdpTotalCount' => [
'description' => 'Udp总请求量。',
'type' => 'integer',
'format' => 'int64',
'example' => '500',
],
'IpCount' => [
'description' => '源IP地址数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'ThreatCount' => [
'description' => '当前版本暂不支持此参数。',
'type' => 'integer',
'format' => 'int64',
'example' => '-',
],
'MaxThreatLevel' => [
'description' => '当前版本暂不支持此参数。',
'type' => 'string',
'example' => '-',
],
'ThreatInfo' => [
'description' => '当前版本暂不支持此参数。',
'type' => 'array',
'items' => [
'description' => '当前版本暂不支持此参数。',
'type' => 'object',
'properties' => [
'ThreatType' => [
'description' => '当前版本暂不支持此参数。',
'type' => 'string',
'example' => '-',
],
'ThreatLevel' => [
'description' => '当前版本暂不支持此参数。',
'type' => 'string',
'example' => '-',
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 49,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"PageNumber\\": 1,\\n \\"Data\\": [\\n {\\n \\"DomainName\\": \\"example.com\\",\\n \\"SubDomain\\": \\"www.example.com\\",\\n \\"V6HttpCount\\": 0,\\n \\"V6HttpsCount\\": 0,\\n \\"TotalCount\\": 500,\\n \\"V4HttpCount\\": 0,\\n \\"V4HttpsCount\\": 0,\\n \\"V4Count\\": 0,\\n \\"V6Count\\": 0,\\n \\"HttpCount\\": 0,\\n \\"HttpsCount\\": 0,\\n \\"DohTotalCount\\": 0,\\n \\"UdpTotalCount\\": 500,\\n \\"IpCount\\": 10,\\n \\"ThreatCount\\": 0,\\n \\"MaxThreatLevel\\": \\"-\\",\\n \\"ThreatInfo\\": [\\n {\\n \\"ThreatType\\": \\"-\\",\\n \\"ThreatLevel\\": \\"-\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => '查询公共DNS请求量统计数据列表',
],
'DescribePdnsOperateLogs' => [
'summary' => '获取公共DNS 操作日志列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsCCJUYL',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ActionType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int64',
],
'RequestId' => [
'type' => 'string',
],
'PageNumber' => [
'type' => 'integer',
'format' => 'int64',
],
'Logs' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OperateTime' => [
'type' => 'string',
],
'Type' => [
'type' => 'string',
],
'Action' => [
'type' => 'string',
],
'content' => [
'type' => 'string',
],
],
],
],
],
],
],
],
'responseDemo' => '',
],
'ResumePdnsService' => [
'summary' => '恢复公共DNS服务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'DescribePdnsAccountSummary' => [
'summary' => '获取公共DNS用户数据概览',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'Data' => [
'type' => 'object',
'properties' => [
'UserId' => [
'type' => 'integer',
'format' => 'int64',
],
'DomainCount' => [
'type' => 'integer',
'format' => 'int64',
],
'SubDomainCount' => [
'type' => 'integer',
'format' => 'int64',
],
'HttpCount' => [
'type' => 'integer',
'format' => 'int64',
],
'HttpsCount' => [
'type' => 'integer',
'format' => 'int64',
],
'TotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'ThreatCount' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
'PausePdnsService' => [
'summary' => '暂停公共DNS服务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ServiceType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
],
'DescribePdnsThreatStatistic' => [
'summary' => '获取公共DNS 威胁统计',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'ThreatSourceIp',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'Timestamp' => [
'type' => 'integer',
'format' => 'int64',
],
'ThreatType' => [
'type' => 'string',
],
'ThreatLevel' => [
'type' => 'string',
],
'DohTotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
'UdpTotalCount' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
'responseDemo' => '',
],
'UpdateIspFlushCacheInstanceConfig' => [
'summary' => '修改缓存刷新套餐包配置',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsIRW4YX',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
],
'SubmitIspFlushCacheTask' => [
'summary' => '提交缓存刷新任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsIRW4YX',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'Isp',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'string',
'required' => true,
],
'required' => true,
'maxItems' => 11,
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'title' => '幂等token',
'type' => 'string',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
],
],
],
],
],
'DescribeIspFlushCacheRemainQuota' => [
'summary' => '获取剩余可缓存刷新次数',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsIRW4YX',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'TelecomRemainQuota' => [
'type' => 'integer',
'format' => 'int32',
],
'RequestId' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '',
],
'DescribeIspFlushCacheInstances' => [
'summary' => '获取缓存刷新套餐包列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsIRW4YX',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '9999999',
'minimum' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'Isp',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'type' => 'integer',
'format' => 'int32',
],
'RequestId' => [
'type' => 'string',
],
'PageNumber' => [
'type' => 'integer',
'format' => 'int32',
],
'IspFlushCacheInstances' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Isp' => [
'type' => 'string',
],
'ExpireTime' => [
'type' => 'string',
],
'InstanceId' => [
'type' => 'string',
],
'QuotaInfo' => [
'type' => 'object',
'properties' => [
'InstanceQuota' => [
'type' => 'integer',
'format' => 'int32',
],
'InstanceQuotaUsed' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
'ExpireTimestamp' => [
'type' => 'integer',
'format' => 'int64',
],
'InstanceName' => [
'type' => 'string',
],
'VersionCode' => [
'type' => 'string',
],
'Status' => [
'type' => 'string',
],
],
],
],
'TotalPages' => [
'type' => 'integer',
'format' => 'int32',
],
'TotalItems' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
'DescribeIspFlushCacheTask' => [
'summary' => '获取缓存刷新任务详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '100699',
'abilityTreeNodes' => [
'FEATUREdnsIRW4YX',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'pattern' => '^\\d+$',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'TaskId' => [
'type' => 'string',
],
'DomainName' => [
'type' => 'string',
],
'InstanceId' => [
'type' => 'string',
],
'InstanceName' => [
'type' => 'string',
],
'Isp' => [
'type' => 'string',
],
'TaskStatus' => [
'type' => 'string',
],
'CreateTime' => [
'type' => 'string',
],
'CreateTimestamp' => [
'type' => 'integer',
'format' => 'int64',
],
'FlushCacheResults' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Province' => [
'type' => 'string',
],
'DnsNodes' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NodeIp' => [
'type' => 'string',
],
'Answers' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => [
'type' => 'string',
],
'Type' => [
'type' => 'string',
],
'Record' => [
'type' => 'string',
],
'Ttl' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
'SpName' => [
'type' => 'string',
],
'Status' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '',
],
'DescribeIspFlushCacheTasks' => [
'summary' => '获取缓存刷新任务列表',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsIRW4YX',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '9999999',
'minimum' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '100',
'minimum' => '1',
],
],
[
'name' => 'Isp',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'type' => 'integer',
'format' => 'int32',
],
'RequestId' => [
'type' => 'string',
],
'PageNumber' => [
'type' => 'integer',
'format' => 'int32',
],
'IspFlushCacheTasks' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskId' => [
'type' => 'string',
],
'DomainName' => [
'type' => 'string',
],
'InstanceId' => [
'type' => 'string',
],
'InstanceName' => [
'type' => 'string',
],
'Isp' => [
'type' => 'string',
],
'TaskStatus' => [
'type' => 'string',
],
'CreateTime' => [
'type' => 'string',
],
'CreateTimestamp' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
'TotalPages' => [
'type' => 'integer',
'format' => 'int32',
],
'TotalItems' => [
'type' => 'integer',
'format' => 'int32',
],
],
],
],
],
],
'DescribeRecordResolveStatisticsSummary' => [
'summary' => '查询指定域名下的全部子域名的请求量统计。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsQIXAM1',
],
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'title' => '可选参数,传递具体域名时查询该域名下各子域名的解析量, 不传递时查询用户账号下所有付费域名的解析量列表',
'description' => '域名名称。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'DomainType',
'in' => 'query',
'schema' => [
'title' => '指定域名时需要传递'."\n"
.'域名类型,大小写不敏感。取值: '."\n"
."\n"
.'权威域名(默认): PUBLIC'."\n"
.'缓存加速域名: CACHE',
'description' => '域名类型,大小写不敏感。取值:'."\n"
."\n"
.'- PUBLIC:权威托管域名(默认值)'."\n"
."\n"
.'- CACHE:权威代理域名',
'type' => 'string',
'required' => false,
'example' => 'PUBLIC',
],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'title' => '关键字,与SearchMode配合使用',
'description' => '关键字,与SearchMode配合使用。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'SearchMode',
'in' => 'query',
'schema' => [
'title' => '关键词的搜索模式。取值:'."\n"
."\n"
.'模糊搜索(默认): LIKE'."\n"
.'精确搜索: EXACT',
'description' => '关键词的搜索模式。取值:'."\n"
."\n"
.'- 模糊搜索(默认):LIKE'."\n"
."\n"
.'- 精确搜索:EXACT',
'type' => 'string',
'required' => false,
'example' => 'LIKE',
],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'title' => '排序方向。取值: '."\n"
.'递减(默认): DESC'."\n"
.'递增: ASC',
'description' => '排序方向。取值:'."\n"
."\n"
.'- 递减(默认):DESC'."\n"
."\n"
.'- 递增:ASC',
'type' => 'string',
'required' => false,
'example' => 'DESC',
],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => [
'title' => '查询总解析量阈值,也可查询相应的解析量不大于threshold的数据。例如,可查询出解析量小于100次的域名。'."\n"
.'不传或者传小于0的值,查询所有数据'."\n"
.'传0,查询无解析量的数据'."\n"
.'传大于0的值,查询解析量不超过该值的域名'."\n",
'description' => '解析量查询条件,可用于查询不同解析量类别的子域名列表及子域名解析量数据。'."\n"
."\n"
.'不传:查询解析量非0的数据'."\n"
."\n"
.'传小于0的值:查询所有数据'."\n"
."\n"
.'传0:查询无解析量的数据'."\n"
."\n"
.'传大于0的值:查询解析量不超过该值的子域名',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'title' => '开始时间,格式yyyy-MM-dd,如: 2023-03-01',
'description' => '开始时间,格式yyyy-MM-dd,如: 2023-03-01。',
'type' => 'string',
'required' => true,
'example' => '2023-03-29',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'title' => '结束时间,格式yyyy-MM-dd,如:2023-03-13',
'description' => '结束时间,格式yyyy-MM-dd,如:2023-03-13。',
'type' => 'string',
'required' => false,
'example' => '2023-03-29',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'title' => '当前页数,起始值为1,默认为1。',
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '分页查询时设置的每页行数,最大值1000,最小值为1。',
'description' => '分页查询时设置的每页行数,最大值1000,最小值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'title' => 'lang,语言:zh、en、ja',
'description' => 'lang,语言:zh、en、ja。',
'type' => 'string',
'required' => false,
'example' => 'zh',
'default' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO>',
'description' => 'PopResultDTO>',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'RequestId',
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**500**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageNumber' => [
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '数据分页后总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '总数据条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Statistics' => [
'description' => '统计数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SubDomain' => [
'title' => '子域名',
'description' => '子域。',
'type' => 'string',
'example' => 'test.example.com',
],
'DomainName' => [
'title' => '子域名',
'description' => '子域名。',
'type' => 'string',
'example' => 'test.example.com',
],
'Count' => [
'description' => '请求量(次)。',
'type' => 'string',
'example' => '330',
],
'DomainType' => [
'description' => '域名类型,大小写不敏感。取值:'."\n"
."\n"
.'- PUBLIC:权威托管域名(默认值)'."\n"
."\n"
.'- CACHE:权威代理域名',
'type' => 'string',
'example' => 'PUBLIC',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Statistics.TooManyResults',
'errorMessage' => 'Your query has produced too many results.',
],
[
'errorCode' => 'Statistics.InvalidDomainName',
'errorMessage' => 'Your query param DomainName is invalid.',
],
[
'errorCode' => 'Statistics.InvalidStartDate',
'errorMessage' => 'Your query param StartDate is invalid.',
],
[
'errorCode' => 'Statistics.InvalidEndDate',
'errorMessage' => 'Your query param EndDate is invalid.',
],
[
'errorCode' => 'Statistics.InvalidSearchMode',
'errorMessage' => 'Your query param SearchMode is invalid.',
],
[
'errorCode' => 'Statistics.InvalidOrderDirection',
'errorMessage' => 'Your query param OrderDirection is invalid.',
],
[
'errorCode' => 'Statistics.InvalidDomainType',
'errorMessage' => 'Your query param DomainType is invalid.',
],
[
'errorCode' => 'Statistics.QuotaExceededTime',
'errorMessage' => 'Your query time range exceeds 90 days.',
],
[
'errorCode' => 'Sys.ParamsError',
'errorMessage' => 'Your query param is invalid.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1,\\n \\"Statistics\\": [\\n {\\n \\"SubDomain\\": \\"test.example.com\\",\\n \\"DomainName\\": \\"test.example.com\\",\\n \\"Count\\": \\"330\\",\\n \\"DomainType\\": \\"PUBLIC\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 389DFFA3-77A5-4A9E-BF3D-147C6F98A5BA\\n 10\\n 1\\n 1\\n 1\\n \\n test.example.com\\n 330\\n PUBLIC\\n \\n","errorExample":""}]',
'title' => '获取子域名的请求量统计',
],
'DescribeDomainResolveStatisticsSummary' => [
'summary' => '查询用户账号下所有付费域名的请求量列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsG5IRRX',
],
],
'parameters' => [
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'title' => '关键字,与SearchMode配合使用',
'description' => '关键字,与SearchMode配合使用。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'SearchMode',
'in' => 'query',
'schema' => [
'title' => '关键词的搜索模式。取值:'."\n"
."\n"
.'模糊搜索(默认): LIKE'."\n"
.'精确搜索: EXACT',
'description' => '关键词的搜索模式。取值:'."\n"
."\n"
.'- 模糊搜索(默认):LIKE'."\n"
."\n"
.'- 精确搜索:EXACT',
'type' => 'string',
'required' => false,
'example' => 'EXACT',
],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => [
'title' => '排序方向。取值: '."\n"
.'递减: DESC'."\n"
.'递增: ASC',
'description' => '排序方向。取值:'."\n"
."\n"
.'- 递减:DESC'."\n"
."\n"
.'- 递增:ASC',
'type' => 'string',
'required' => false,
'example' => 'DESC',
],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => [
'title' => '查询总解析量阈值,也可查询相应的解析量不大于threshold的数据。例如,可查询出解析量小于100次的域名。'."\n"
.'不传或者传小于0的值,查询所有数据'."\n"
.'传0,查询无解析量的数据'."\n"
.'传大于0的值,查询解析量不超过该值的域名'."\n",
'description' => '解析量查询条件,可用于查询不同解析量类别的域名列表及域名解析量数据。'."\n"
."\n"
.'不传:查询解析量不为0的数据'."\n"
."\n"
.'传小于0的值:查询所有数据'."\n"
."\n"
.'传0:查询无解析量的数据'."\n"
."\n"
.'传大于0的值:查询解析量不超过该值的域名',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'title' => '开始时间,格式yyyy-MM-dd,如: 2023-03-01',
'description' => '开始时间,格式yyyy-MM-dd,如: 2023-03-01',
'type' => 'string',
'required' => true,
'example' => '2023-03-01',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'title' => '结束时间,格式yyyy-MM-dd,如:2023-03-13',
'description' => '结束时间,格式yyyy-MM-dd,如:2023-03-13',
'type' => 'string',
'required' => false,
'example' => '2023-03-01',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'title' => '当前页数,起始值为1,默认为1。',
'description' => '当前页数,起始值为1,默认为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '分页查询时设置的每页行数,最大值1000,最小值为1。',
'description' => '分页查询时设置的每页行数,最大值1000,最小值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'title' => 'lang,语言:zh、en、ja',
'description' => 'lang,语言:zh、en、ja。',
'type' => 'string',
'required' => false,
'example' => 'zh',
'default' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO>',
'description' => 'PopResultDTO>',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'RequestId',
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6856BCF6-11D6-4D7E-AC53-FD579933522B',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数,最大值**100**,默认为**20**。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'PageNumber' => [
'description' => '当前页数,起始值为**1**,默认为**1**。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPages' => [
'description' => '数据分页后总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalItems' => [
'description' => '总数据条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Statistics' => [
'description' => '统计数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名名称。',
'type' => 'string',
'example' => 'example.com',
],
'Count' => [
'description' => '请求量(次)。',
'type' => 'string',
'example' => '35509014',
],
'DomainType' => [
'description' => '域名类型。'."\n"
."\n"
.'- PUBLIC:权威托管域名'."\n"
."\n"
.' - CACHE:权威代理域名',
'type' => 'string',
'example' => 'CACHE',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'Statistics.TooManyResults',
'errorMessage' => 'Your query has produced too many results.',
],
[
'errorCode' => 'Statistics.InvalidDomainName',
'errorMessage' => 'Your query param DomainName is invalid.',
],
[
'errorCode' => 'Statistics.InvalidStartDate',
'errorMessage' => 'Your query param StartDate is invalid.',
],
[
'errorCode' => 'Statistics.InvalidEndDate',
'errorMessage' => 'Your query param EndDate is invalid.',
],
[
'errorCode' => 'Statistics.InvalidSearchMode',
'errorMessage' => 'Your query param SearchMode is invalid.',
],
[
'errorCode' => 'Statistics.InvalidOrderDirection',
'errorMessage' => 'Your query param OrderDirection is invalid.',
],
[
'errorCode' => 'Statistics.InvalidDomainType',
'errorMessage' => 'Your query param DomainType is invalid.',
],
[
'errorCode' => 'Statistics.QuotaExceededTime',
'errorMessage' => 'Your query time range exceeds 90 days.',
],
[
'errorCode' => 'Sys.ParamsError',
'errorMessage' => 'Your query param is invalid.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6856BCF6-11D6-4D7E-AC53-FD579933522B\\",\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalItems\\": 1,\\n \\"Statistics\\": [\\n {\\n \\"DomainName\\": \\"example.com\\",\\n \\"Count\\": \\"35509014\\",\\n \\"DomainType\\": \\"CACHE\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '获取域名的请求量统计列表',
],
'DescribeInternetDnsLogs' => [
'summary' => '查询解析日志',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdnsCCJUYL',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '返回值语言,取值:'."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认:en',
'type' => 'string',
'required' => false,
'example' => 'en',
],
],
[
'name' => 'StartTimestamp',
'in' => 'query',
'schema' => [
'description' => '查询的开始时间(时间戳,单位:毫秒)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1738848000000',
],
],
[
'name' => 'EndTimestamp',
'in' => 'query',
'schema' => [
'description' => '查询的结束时间(时间戳,单位:毫秒)。'."\n"
.'>如果查询时间段跨度较大,查询域名的解析日志量过多,可能会导致查询超时或者查询结果不准确。>',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1741526400000',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码,默认值为1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Module',
'in' => 'query',
'schema' => [
'description' => '模块类型'."\n"
.'- AUTHORITY(默认值):公网权威DNS'."\n"
.'- RECURSION:公网递归DNS',
'type' => 'string',
'required' => false,
'example' => 'AUTHORITY',
],
],
[
'name' => 'QueryCondition',
'in' => 'query',
'schema' => [
'description' => '查询参数'."\n"
.'- sourceIp:源IP地址'."\n"
.'- queryNameFuzzy:域名(模糊值)'."\n"
.'- queryType:记录类型'."\n"
.'- value:解析结果'."\n"
.'- status:状态'."\n"
.'- serverIp:解析服务器IP',
'type' => 'string',
'required' => false,
'example' => '{"sourceIp":"59.82.XX.XX","queryType":"A"}',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => false,
'example' => 'www.example.com',
],
],
[
'name' => 'AccountId',
'in' => 'query',
'schema' => [
'description' => '公共DNS专属配置ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '51**4',
],
],
[
'name' => 'RecursionProtocolType',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'PreciseSort',
'in' => 'query',
'schema' => [
'title' => '是否精确排序,不精确排序的性能高于精确排序。缺省值为FALSE'."\n"
.'FALSE:不精确排序'."\n"
.'TRUE:精确排序',
'description' => '是否精确排序,不精确排序的性能高于精确排序。缺省值为FALSE'."\n"
.'FALSE:不精确排序'."\n"
.'TRUE:精确排序',
'type' => 'boolean',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '536E9CAD-DB30-4647-AC87-AA5CC38C5382',
],
'Complete' => [
'description' => '解析日志查询是否精确。',
'type' => 'boolean',
'example' => 'true',
],
'Logs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Log' => [
'description' => '日志列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => '日志对象。',
'type' => 'object',
'properties' => [
'DnsMsgId' => [
'description' => '解析日志ID(会重复)。',
'type' => 'string',
'example' => '3583',
],
'LogTime' => [
'description' => '解析时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1709196249000',
],
'ZoneName' => [
'description' => '域名(Zone)名称。',
'type' => 'string',
'example' => 'example.com',
],
'QueryName' => [
'description' => '是指子域名,即查询的解析记录的域名。',
'type' => 'string',
'example' => 'www.example.com',
],
'QueryType' => [
'description' => '记录类型。',
'type' => 'string',
'example' => 'A',
],
'Rt' => [
'description' => '解析响应时间。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ServerIp' => [
'description' => '解析服务器IP。',
'type' => 'string',
'example' => '140.205.XX.XX',
],
'SourceIp' => [
'description' => '源IP地址。',
'type' => 'string',
'example' => '59.82.XX.XX',
],
'Status' => [
'description' => '响应状态。',
'type' => 'string',
'example' => 'NOERROR',
],
'SubnetIp' => [
'description' => 'edns-client-subnet 可选项设置的值。',
'type' => 'string',
'example' => '170.33.XX.XX',
],
'Protocol' => [
'description' => '域名解析查询请求的协议类型:'."\n"
."\n"
.'- UDP'."\n"
."\n"
.'- TCP'."\n"
."\n"
.'- HTTP'."\n"
."\n"
.'- HTTPS'."\n"
."\n"
.'- DOH',
'type' => 'string',
'example' => 'UDP',
],
'Value' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Value' => [
'description' => '解析结果数组。',
'type' => 'array',
'items' => [
'description' => '解析结果。',
'type' => 'string',
'example' => '172.64.XX.XX',
],
],
],
],
'ResponseTimestamp' => [
'type' => 'string',
],
'QueryFlags' => [
'type' => 'string',
],
'Flags' => [
'type' => 'string',
],
],
],
],
],
],
'PageSize' => [
'description' => '分页查询大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'CurPage' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPage' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalSize' => [
'description' => '总数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '48',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"536E9CAD-DB30-4647-AC87-AA5CC38C5382\\",\\n \\"Complete\\": true,\\n \\"Logs\\": {\\n \\"Log\\": [\\n {\\n \\"DnsMsgId\\": \\"3583\\",\\n \\"LogTime\\": 1709196249000,\\n \\"ZoneName\\": \\"example.com\\",\\n \\"QueryName\\": \\"www.example.com\\",\\n \\"QueryType\\": \\"A\\",\\n \\"Rt\\": 0,\\n \\"ServerIp\\": \\"140.205.XX.XX\\",\\n \\"SourceIp\\": \\"59.82.XX.XX\\",\\n \\"Status\\": \\"NOERROR\\",\\n \\"SubnetIp\\": \\"170.33.XX.XX\\",\\n \\"Protocol\\": \\"UDP\\",\\n \\"Value\\": {\\n \\"Value\\": [\\n \\"172.64.XX.XX\\"\\n ]\\n },\\n \\"ResponseTimestamp\\": \\"\\",\\n \\"QueryFlags\\": \\"\\",\\n \\"Flags\\": \\"\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 10,\\n \\"CurPage\\": 1,\\n \\"TotalPage\\": 5,\\n \\"TotalSize\\": 48\\n}","type":"json"}]',
'title' => '查询公网解析日志',
],
],
'endpoints' => [
[
'regionId' => 'public',
'endpoint' => 'alidns.aliyuncs.com',
],
],
];