'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Domain',
'version' => '2018-01-29',
],
'directories' => [
[
'id' => 169607,
'title' => '域名注册、续费和赎回',
'type' => 'directory',
'children' => [
'SaveSingleTaskForCreatingOrderActivate',
'SaveBatchTaskForCreatingOrderActivate',
'SaveBatchTaskForCreatingOrderRenew',
'SaveSingleTaskForCreatingOrderRenew',
'SaveSingleTaskForCreatingOrderRedeem',
'SaveBatchTaskForCreatingOrderRedeem',
'CheckDomain',
'FuzzyMatchDomainSensitiveWord',
'BatchFuzzyMatchDomainSensitiveWord',
'SetupDomainAutoRenew',
],
],
[
'id' => 60935,
'title' => '模板管理',
'type' => 'directory',
'children' => [
'SaveRegistrantProfile',
'DeleteRegistrantProfile',
'DeleteContactTemplates',
'RegistrantProfileRealNameVerification',
'SetDefaultRegistrantProfile',
'QueryDomainAdminDivision',
'QueryFailReasonForRegistrantProfileRealNameVerification',
'VerifyContactField',
'QueryRegistrantProfiles',
'QueryRegistrantProfileRealNameVerificationInfo',
],
],
[
'id' => 60921,
'title' => '实名认证',
'type' => 'directory',
'children' => [
'SaveTaskForSubmittingDomainRealNameVerificationByIdentityCredential',
'SaveTaskForSubmittingDomainRealNameVerificationByRegistrantProfileID',
'CancelDomainVerification',
'QueryDomainRealNameVerificationInfo',
'QueryFailReasonForDomainRealNameVerification',
],
],
[
'id' => 169608,
'title' => '邮箱验证',
'type' => 'directory',
'children' => [
'DeleteEmailVerification',
'VerifyEmail',
'ResendEmailVerification',
'SubmitEmailVerification',
'QueryEmailVerification',
'ListEmailVerification',
],
],
[
'id' => 169609,
'title' => '域名过户和信息修改',
'type' => 'directory',
'children' => [
'SaveSingleTaskForUpdateProhibitionLock',
'SaveBatchTaskForUpdateProhibitionLock',
'SaveTaskForUpdatingRegistrantInfoByRegistrantProfileID',
'SaveTaskForUpdatingRegistrantInfoByIdentityCredential',
'SaveSingleTaskForUpdatingContactInfo',
'SaveBatchTaskForUpdatingContactInfoByNewContact',
'SaveBatchTaskForUpdatingContactInfoByRegistrantProfileId',
],
],
[
'id' => 60926,
'title' => '域名转移管理',
'type' => 'directory',
'children' => [
'SaveBatchTaskForCreatingOrderTransfer',
'SaveSingleTaskForCreatingOrderTransfer',
'SaveSingleTaskForCancelingTransferIn',
'SaveSingleTaskForCancelingTransferOut',
'TransferInReenterTransferAuthorizationCode',
'TransferInResendMailToken',
'TransferInRefetchWhoisEmail',
'TransferInCheckMailToken',
'SaveSingleTaskForQueryingTransferAuthorizationCode',
'SaveBatchTaskForTransferProhibitionLock',
'SaveSingleTaskForTransferProhibitionLock',
'ConfirmTransferInEmail',
'QueryTransferInByInstanceId',
'QueryTransferInList',
'QueryTransferOutInfo',
'CheckTransferInFeasibility',
'SaveSingleTaskForApplyQuickTransferOutOpenly',
'SaveBatchTaskForApplyQuickTransferOutOpenly',
],
],
[
'id' => 169613,
'title' => '任务管理',
'type' => 'directory',
'children' => [
'CancelTask',
'AcknowledgeTaskResult',
'QueryTaskDetailHistory',
'PollTaskResult',
'QueryTaskList',
'QueryTaskInfoHistory',
'QueryTaskDetailList',
],
],
[
'id' => 60915,
'title' => '域名信息查询',
'type' => 'directory',
'children' => [
'QueryDomainByDomainName',
'QueryContactInfo',
'QueryDomainByInstanceId',
'QueryDomainList',
'ScrollDomainList',
'QueryDomainSuffix',
'QueryAdvancedDomainList',
'LookupTmchNotice',
'CheckDomainSunriseClaim',
'QueryArtExtension',
],
],
[
'id' => 169614,
'title' => 'DNS管理',
'type' => 'directory',
'children' => [
'SaveSingleTaskForCreatingDnsHost',
'SaveSingleTaskForAddingDSRecord',
'SaveSingleTaskForDeletingDnsHost',
'SaveSingleTaskForDeletingDSRecord',
'SaveSingleTaskForSynchronizingDnsHost',
'SaveSingleTaskForSynchronizingDSRecord',
'SaveSingleTaskForModifyingDnsHost',
'SaveSingleTaskForModifyingDSRecord',
'SaveBatchTaskForModifyingDomainDns',
'QueryDnsHost',
'QueryDSRecord',
],
],
[
'id' => 169615,
'title' => '分组管理',
'type' => 'directory',
'children' => [
'DeleteDomainGroup',
'UpdateDomainToDomainGroup',
'SaveDomainGroup',
'QueryDomainGroupList',
],
],
[
'id' => 165272,
'title' => '注册局锁管理',
'type' => 'directory',
'children' => [
'QueryServerLock',
'CheckProcessingServerLockApply',
'CheckMaxYearOfServerLock',
'ListServerLock',
],
],
[
'id' => 60943,
'title' => '.餐厅/.商标等资质管理',
'type' => 'directory',
'children' => [
'SubmitOperationAuditInfo',
'SubmitOperationCredentials',
'CancelOperationAudit',
'CancelQualificationVerification',
'ResetQualificationVerification',
'SaveRegistrantProfileRealNameVerification',
'QueryFailingReasonListForQualification',
'QueryOperationAuditInfoDetail',
'QueryOperationAuditInfoList',
'QueryQualificationDetail',
'GetOperationOssUploadPolicy',
],
],
[
'id' => 60956,
'title' => '其他接口',
'type' => 'directory',
'children' => [
[
'id' => 60918,
'title' => '隐私保护',
'type' => 'directory',
'children' => [
'SaveBatchTaskForDomainNameProxyService',
'SaveSingleTaskForDomainNameProxyService',
],
],
'SaveTaskForSubmittingDomainDelete',
'SaveSingleTaskForAssociatingEns',
'SaveSingleTaskForDisassociatingEns',
'SaveBatchDomainRemark',
'SaveSingleTaskForSaveArtExtension',
'QueryChangeLogList',
'QueryLocalEnsAssociation',
'QueryEnsAssociation',
'GetQualificationUploadPolicy',
'ChangeResourceGroup',
'SaveBatchTaskForReserveDropListDomain',
],
],
[
'id' => 172550,
'title' => '其他',
'type' => 'directory',
'children' => [
'QueryIntlFixedPriceOrderList',
'CheckIntlFixPriceDomainStatus',
'CreateIntlFixedPriceDomainOrder',
'GetIntlFixPriceDomainListUrl',
'DomainSpecialBizCancel',
'SubmitDomainSpecialBizCredentials',
'QueryDomainSpecialBizInfoByDomain',
'QueryDomainSpecialBizDetail',
'SaveBatchTaskForTransferOutByAuthorizationCode',
'SaveSingleTaskForTransferOutByAuthorizationCode',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'SaveSingleTaskForCreatingOrderActivate' => [
'summary' => '提交域名注册任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'ZhRegistrantName',
'in' => 'query',
'schema' => [
'description' => '域名联系人(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '想要注册的域名。'."\n"
.'>注册域名时必须指定域名持有者信息,不指定域名持有者信息会导致域名注册失败。您可以通过RegistrantProfileId参数指定信息模板定义域名持有者信息。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'SubscriptionDuration',
'in' => 'query',
'schema' => [
'description' => '购买周期,单位为**年**。默认为**1年**,最长可购买**10年**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '域名信息模板编号(信息模板包含域名持有者名称、域名联系人、电话、邮箱等信息),仅能使用已实名认证的域名信息模板编号进行域名注册。如果您已经创建了域名注册信息模板,可通过调用[QueryRegistrantProfiles](~~QueryRegistrantProfiles~~)接口查询域名信息模板编号。'."\n"
."\n"
.'> 传入本参数后,无需再传入**RegistrantType**、**ZhRegistrantOrganization**、**ZhRegistrantName**、**ZhProvince**、**ZhCity**、**ZhAddress**、**RegistrantOrganization**、**RegistrantName**、**Province**、**City**、**Address**、**PostalCode**、**Country**、**TelArea**、**Telephone**、**TelExt**和**Email**参数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
],
[
'name' => 'EnableDomainProxy',
'in' => 'query',
'schema' => [
'description' => '是否开启域名隐私保护服务。取值:'."\n"
.'- **true**:开启。'."\n"
.'- **false**:不开启。'."\n"
."\n"
.'默认值为**true**。'."\n"
."\n"
.' ',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'true',
],
],
[
'name' => 'PermitPremiumActivation',
'in' => 'query',
'schema' => [
'description' => '是否允许注册白金词,取值:'."\n"
.'- **false**:不允许。'."\n"
.'- **true**:允许。 '."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'AliyunDns',
'in' => 'query',
'schema' => [
'description' => '是否使用阿里云DNS,取值为**true**|**false**,默认为**true**。'."\n"
."\n"
.'> - 取值为**true**时,您无需再传入**Dns1**和**Dns2**参数,否则传入的**Dns1**和**Dns2**参数不会生效。'."\n"
.'- 取值为**false**时,您还需要传入**Dns1**和**Dns2**参数。'."\n"
.' ',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'true',
],
],
[
'name' => 'Dns1',
'in' => 'query',
'schema' => [
'description' => '自定义DNS1。'."\n"
."\n"
.'> - 当**AliyunDns**取值为**false**时,本参数才可用且必须传入。'."\n"
.'- 请务必确保自定义DNS的正确性,否则可能导致注册失败。',
'type' => 'string',
'required' => false,
'example' => 'ns1.aliyun.com',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '城市(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '北京市',
],
],
[
'name' => 'ZhRegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'Country',
'in' => 'query',
'schema' => [
'description' => '国家代码,例如**CN**。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
],
[
'name' => 'Dns2',
'in' => 'query',
'schema' => [
'description' => '自定义DNS2。'."\n"
."\n"
.'> - 当**AliyunDns**取值为**false**时,本参数才可用且必须传入。'."\n"
.'- 请务必确保自定义DNS的正确性,否则可能导致注册失败。',
'type' => 'string',
'required' => false,
'example' => 'ns2.aliyun.com',
],
],
[
'name' => 'ZhProvince',
'in' => 'query',
'schema' => [
'description' => '省份(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '北京',
],
],
[
'name' => 'ZhAddress',
'in' => 'query',
'schema' => [
'description' => '详细地址(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '朝阳区',
],
],
[
'name' => 'City',
'in' => 'query',
'schema' => [
'description' => '城市(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'bei jing shi',
],
],
[
'name' => 'RegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'ce shi',
],
],
[
'name' => 'RegistrantName',
'in' => 'query',
'schema' => [
'description' => '域名联系人(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'ce shi',
],
],
[
'name' => 'Province',
'in' => 'query',
'schema' => [
'description' => '省份(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'bei jing',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'description' => '详细地址(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'chao yang qu',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '电子邮箱。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'username@example.com',
],
],
[
'name' => 'PostalCode',
'in' => 'query',
'schema' => [
'description' => '邮政编码。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '1234567',
],
],
[
'name' => 'TelArea',
'in' => 'query',
'schema' => [
'description' => '电话国家代码,例如中国为**86**。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '86',
],
],
[
'name' => 'Telephone',
'in' => 'query',
'schema' => [
'description' => '电话号码。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '12345678',
],
],
[
'name' => 'TelExt',
'in' => 'query',
'schema' => [
'description' => '分机号码。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '1234',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '域名持有者类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业、组织等。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'TrademarkDomainActivation',
'in' => 'query',
'schema' => [
'description' => '是否允许注册商标词,取值:'."\n"
.'- **false**:不允许。'."\n"
.'- **true**:允许。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'CouponNo',
'in' => 'query',
'schema' => [
'description' => '代金券编号,默认为字符串。',
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'UseCoupon',
'in' => 'query',
'schema' => [
'description' => '是否使用代金券。取值:'."\n"
."\n"
.'- **true**:使用'."\n"
.'- **false**:不使用'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '优惠券编号。',
'type' => 'string',
'required' => false,
'example' => '123123',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '是否使用优惠券,取值:'."\n"
.'- **false**:不允许。'."\n"
.'- **true**:允许。'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '无。',
'type' => 'string',
'required' => false,
'example' => 'rg-XX',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}\\n\\t\\t\\t\\t\\t"},{"type":"xml","example":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n","errorExample":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n"}]',
'title' => '提交域名注册任务',
'description' => '2022年3月1日起,仅能通过已实名认证的域名信息模板注册域名,不再支持传入持有者信息注册域名。'."\n"
."\n"
.'注册域名需同时填写您想注册的域名、域名持有者信息及DNS。您需要通过已实名认证的域名信息模板编号来关联域名的持有者信息,DNS可以默认使用阿里云DNS或者填写自定义DNS。'."\n"
."\n"
.'任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForCreatingOrderActivate' => [
'summary' => '提交批量注册域名的任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'CouponNo',
'in' => 'query',
'schema' => [
'description' => '代金券编号。',
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'UseCoupon',
'in' => 'query',
'schema' => [
'description' => '是否使用代金券。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '优惠券编号。',
'type' => 'string',
'required' => false,
'example' => '123124',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '是否使用优惠券。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'OrderActivateParam',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '任务详情列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TelExt' => [
'description' => '分机号码。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '1234',
],
'AliyunDns' => [
'description' => '是否使用阿里云DNS,取值为**true**|**false**,默认为**true**。'."\n"
."\n"
.'> - 取值为**true**时,您无需再传入**OrderActivateParam.N.Dns1**和**OrderActivateParam.N.Dns2**参数,否则传入的**OrderActivateParam.N.Dns1**和**OrderActivateParam.N.Dns2**参数不会生效。 '."\n"
.'- 取值为**false**时,您还需要传入**OrderActivateParam.N.Dns1**和**OrderActivateParam.N.Dns2**参数。'."\n",
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'PermitPremiumActivation' => [
'description' => '是否允许注册白金词,默认为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'ZhProvince' => [
'description' => '省份(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '北京',
],
'Telephone' => [
'description' => '电话号码。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '1820000****',
],
'RegistrantOrganization' => [
'description' => '域名持有者名称(英文)。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'zhang san',
],
'City' => [
'description' => '城市(英文)。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'bei jing shi',
],
'DomainName' => [
'description' => '想要注册的域名。'."\n"
."\n"
.'> 注册域名时必须指定域名持有者信息,不指定域名持有者信息会导致域名注册失败。您可以通过OrderActivateParam.N.RegistrantProfileId参数指定信息模板定义域名持有者信息。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
'ZhCity' => [
'description' => '城市(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '北京市',
],
'Dns1' => [
'description' => '自定义DNS1。'."\n"
."\n"
.'> - 当**OrderActivateParam.N.AliyunDns**取值为**false**时,本参数才可用且必须传入。'."\n"
.'- 请务必确保自定义DNS的正确性,否则可能导致注册失败。',
'type' => 'string',
'required' => false,
'example' => 'ns2.aliyun.com',
],
'TelArea' => [
'description' => '电话国家代码,例如,中国的电话国家代码为**86**。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '86',
],
'Address' => [
'description' => '通讯地址(英文)。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'chao yan qu *** dasha *** hao',
],
'EnableDomainProxy' => [
'description' => '是否开启域名隐私保护服务,默认为**true**。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'PostalCode' => [
'description' => '邮政编码。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '102629',
],
'RegistrantProfileId' => [
'description' => '域名信息模板编号(信息模板包含域名持有者名称、域名联系人、电话、邮箱等信息),仅能使用已实名认证的域名信息模板编号进行域名注册。如果您已经创建了域名注册信息模板,可通过调用[QueryRegistrantProfiles](~~67701~~) 接口查询域名信息模板编号。'."\n"
."\n"
.'> 传入本参数后,无需再传入**OrderActivateParam.N.RegistrantType**、**OrderActivateParam.N.ZhRegistrantOrganization**、**OrderActivateParam.N.ZhRegistrantName**、**OrderActivateParam.N.ZhProvince**、**OrderActivateParam.N.ZhCity**、**OrderActivateParam.N.ZhAddress**、**OrderActivateParam.N.RegistrantOrganization**、**OrderActivateParam.N.RegistrantName**、**OrderActivateParam.N.Province**、**OrderActivateParam.N.City**、**OrderActivateParam.N.Address**、**OrderActivateParam.N.PostalCode**、**OrderActivateParam.N.Country**、**OrderActivateParam.N.TelArea**、**OrderActivateParam.N.Telephone**、**OrderActivateParam.N.TelExt**和**OrderActivateParam.N.Email**参数。'."\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '000000',
],
'ZhRegistrantOrganization' => [
'description' => '域名持有者名称(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '张三',
],
'TrademarkDomainActivation' => [
'description' => '是否允许注册商标词。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'Dns2' => [
'description' => '自定义DNS2。'."\n"
."\n"
.'> - 当**OrderActivateParam.N.AliyunDns**取值为**false**时,本参数才可用且必须传入。'."\n"
.'- 请务必确保自定义DNS的正确性,否则可能导致注册失败。',
'type' => 'string',
'required' => false,
'example' => 'ns1.aliyun.com',
],
'ZhRegistrantName' => [
'description' => '域名联系人(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '张三',
],
'Email' => [
'description' => '电子邮箱。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'username@example.com',
],
'RegistrantType' => [
'description' => '域名持有者类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业、组织等。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '1',
],
'Country' => [
'description' => '国家代码。例如,**CN**代表中国,**US**代表美国。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
'RegistrantName' => [
'description' => '域名联系人(英文)。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'zhang san',
],
'SubscriptionDuration' => [
'description' => '购买周期,单位为**年**。默认为**一年**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'ZhAddress' => [
'description' => '通讯地址(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '朝阳区***大厦***号',
],
'Province' => [
'description' => '省份(英文)。'."\n"
."\n"
.'> 当未传入**OrderActivateParam.N.RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'bei jing',
],
'ResourceGroupId' => [
'description' => '资源组ID。'."\n"
.'> 若没有传入资源组ID或传入的资源组ID不存在,则绑定默认资源组ID。',
'type' => 'string',
'required' => false,
'example' => 'rg-XX',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f5492a',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\",\\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\",\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\"\\n}"},{"type":"xml","example":"\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n","errorExample":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n"}]',
'title' => '提交批量注册域名任务',
'description' => '2022年3月1日起,仅能通过已实名认证的域名信息模板注册域名,不再支持传入持有者信息注册域名。'."\n"
."\n"
.'注册域名需同时填写您想注册的域名、域名持有者信息及DNS。您需要通过已实名认证的域名信息模板编号来关联域名的持有者信息,DNS可以默认使用阿里云DNS或者填写自定义DNS。'."\n"
."\n"
.'> - 每周注册的域名总数不能超过10万。'."\n"
.'>- 注册付费只能通过账户现金余额,不支持额度。'."\n"
.'- **SaveBatchTaskForCreatingOrderActivate**接口下请求参数的格式为OrderActivateParam.N.*,其中N代表传入的第几个域名。'."\n"
."\n\n"
.'任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForCreatingOrderRenew' => [
'summary' => '提交批量域名续费任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'CouponNo',
'in' => 'query',
'schema' => [
'description' => '代金券编号。',
'type' => 'string',
'required' => false,
'example' => '12312412',
],
],
[
'name' => 'UseCoupon',
'in' => 'query',
'schema' => [
'description' => '是否使用代金券。取值:'."\n"
."\n"
.'- **false**:不使用。'."\n"
.'- **true**:使用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '优惠券编号。',
'type' => 'string',
'required' => false,
'example' => '123123123',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '是否使用优惠券。取值:'."\n"
."\n"
.'- **false**:不使用。'."\n"
.'- **true**:使用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'OrderRenewParam',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名续费的变更参数列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SubscriptionDuration' => [
'description' => '续费年限。默认为**1**年。范围为**1**~**10**年。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'DomainName' => [
'description' => '域名,如涉及多个域名时该项传入域名列表。域名列表可通过[QueryDomainList](~~67712~~)接口获取。',
'type' => 'string',
'required' => false,
'example' => 'Aliyun.com',
],
'CurrentExpirationDate' => [
'description' => '域名当前到期日,计算方式为UTC时间1970年1月1日0点距离域名当前到期日的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f5492a',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\",\\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"9DFBA504-3C59-427D-907D-B6C61F2A3A27\\",\\n \\"taskNo\\": \\"2daff10d-c284-4b98-a6f4-796148116b2b\\"\\n}"},{"type":"xml","example":"\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n","errorExample":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n"}]',
'title' => '提交批量域名续费任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForCreatingOrderRenew' => [
'summary' => '调用SaveSingleTaskForCreatingOrderRenew提交域名续费任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '需要续费的域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'SubscriptionDuration',
'in' => 'query',
'schema' => [
'description' => '续费年限值,范围:**1**年~**10**年。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'CurrentExpirationDate',
'in' => 'query',
'schema' => [
'description' => '域名当前的到期时间,计算方式为UTC时间1970年1月1日0点距离域名当前到期时间的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1522080000000',
],
],
[
'name' => 'CouponNo',
'in' => 'query',
'schema' => [
'description' => '代金券编号。',
'type' => 'string',
'required' => false,
'example' => '123123',
],
],
[
'name' => 'UseCoupon',
'in' => 'query',
'schema' => [
'description' => '是否使用代金券。取值:'."\n"
."\n"
.'- **false**:不使用。'."\n"
.'- **true**:使用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '优惠券编号。',
'type' => 'string',
'required' => false,
'example' => '123132',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '是否使用优惠券。取值:'."\n"
."\n"
.'- **false**:不使用。'."\n"
.'- **true**:使用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"D9422F19-3C86-44FA-B5F7-036E89F3904F\\",\\n \\"taskNo\\": \\"9f7a509f-f347-4430-969b-52ed6d23e58f\\"\\n}"},{"type":"xml","example":"\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n","errorExample":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n"}]',
'title' => '提交域名续费任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForCreatingOrderRedeem' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '想要赎回的域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'CurrentExpirationDate',
'in' => 'query',
'schema' => [
'description' => '域名当前到期时间,UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '0000',
],
],
[
'name' => 'CouponNo',
'in' => 'query',
'schema' => [
'description' => '代金券编号。',
'type' => 'string',
'required' => false,
'example' => '123123',
],
],
[
'name' => 'UseCoupon',
'in' => 'query',
'schema' => [
'description' => '是否使用代金券。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '优惠券编号。',
'type' => 'string',
'required' => false,
'example' => '123123',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '是否使用优惠券。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}"},{"type":"xml","example":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n","errorExample":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n"}]',
'title' => '提交域名赎回任务',
'summary' => '调用SaveSingleTaskForCreatingOrderRedeem提交域名赎回任务。',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForCreatingOrderRedeem' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'CouponNo',
'in' => 'query',
'schema' => [
'description' => '代金券编号。',
'type' => 'string',
'required' => false,
'example' => '123123',
],
],
[
'name' => 'UseCoupon',
'in' => 'query',
'schema' => [
'description' => '是否使用代金券。取值:'."\n"
."\n"
.'- **false**:不使用。'."\n"
.'- **true**:使用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '优惠券编号。',
'type' => 'string',
'required' => false,
'example' => '123213123',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '是否使用优惠券。取值:'."\n"
."\n"
.'- **false**:不使用。'."\n"
.'- **true**:使用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'OrderRedeemParam',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '任务详情列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '域名,如涉及多个域名时该项传入域名列表。域名列表可通过[QueryDomainList](~~67712~~)接口获取。',
'type' => 'string',
'required' => false,
'example' => 'Aliyun.com',
],
'CurrentExpirationDate' => [
'description' => '域名当前到期日,计算方式为UTC时间1970年1月1日0点距离域名当前到期日的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '000000',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f5492a',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\",\\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\",\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\"\\n}"},{"type":"xml","example":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n","errorExample":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n"}]',
'title' => '提交批量域名赎回任务',
'summary' => '调用SaveBatchTaskForCreatingOrderRedeem提交批量域名赎回任务。',
'description' => '任务执行结果请通过[查询任务详情列表](~~67710~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckDomain' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test**.xin',
],
],
[
'name' => 'FeeCommand',
'in' => 'query',
'schema' => [
'description' => '操作命令。取值:'."\n"
.'- **create**:新购。'."\n"
.'- **renew**:续费。'."\n"
.'- **transfer**:转入。'."\n"
.'- **restore**:赎回。'."\n"
.' ',
'type' => 'string',
'required' => false,
'example' => 'create',
],
],
[
'name' => 'FeeCurrency',
'in' => 'query',
'schema' => [
'description' => '货币类型。取值: **USD**(美元)。'."\n"
."\n"
.' ',
'type' => 'string',
'required' => false,
'example' => 'USD',
],
],
[
'name' => 'FeePeriod',
'in' => 'query',
'schema' => [
'description' => '购买周期年限,单位为**年**。范围为**1**~**10**年。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1',
],
'Avail' => [
'description' => '域名是否可以注册。取值:'."\n"
.'- **1**:可注册。'."\n"
.'- **3**:预登记。'."\n"
.'- **4**:可删除预订。'."\n"
.'- **0**:不可注册。'."\n"
.'- **-1**:异常。'."\n"
.'- **-2**:暂停注册。'."\n"
.'- **-3**:黑名单。'."\n"
.' ',
'type' => 'string',
'example' => '1',
],
'Price' => [
'description' => '溢价词注册价格。',
'type' => 'integer',
'format' => 'int64',
'example' => '1286',
],
'DomainName' => [
'description' => '查询的域名名称。',
'type' => 'string',
'example' => 'test**.xin',
],
'Premium' => [
'description' => '是否是溢价词。取值:'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n"
.' ',
'type' => 'string',
'example' => 'true',
],
'DynamicCheck' => [
'description' => '是否动态询价。取值:'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。',
'type' => 'boolean',
'example' => 'true',
],
'Reason' => [
'description' => '由注册局返回的不可注册原因。'."\n"
.'>根据注册局的不同,返回的不可注册原因不一致。'."\n",
'type' => 'string',
'example' => 'In use',
],
'StaticPriceInfo' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PriceInfo' => [
'description' => '静态价格信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'action' => [
'description' => '操作类型'."\n"
."\n"
.'- activate:新购',
'type' => 'string',
'example' => 'activate',
],
'money' => [
'description' => '金额,单位元。',
'type' => 'number',
'format' => 'double',
'example' => '78.0',
],
'period' => [
'description' => '周期,单位月。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\",\\n \\"Avail\\": \\"1\\",\\n \\"Price\\": 1286,\\n \\"DomainName\\": \\"test**.xin\\",\\n \\"Premium\\": \\"true\\",\\n \\"DynamicCheck\\": true,\\n \\"Reason\\": \\"In use\\",\\n \\"StaticPriceInfo\\": {\\n \\"PriceInfo\\": [\\n {\\n \\"action\\": \\"activate\\",\\n \\"money\\": 78,\\n \\"period\\": 12\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\",\\n \\"DomainName\\": \\"abc.xin\\",\\n \\"Avail\\": 0,\\n \\"Premium\\": false,\\n \\"Reason\\": \\"\\",\\n \\"Price\\": 1286\\n}"},{"type":"xml","example":"\\n BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\n test**.xin\\n 1\\n false\\n \\n 1286\\n","errorExample":"\\n BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\n abc.xin\\n 1\\n true\\n \\n 1286\\n"}]',
'title' => '检查域名是否可以注册',
'summary' => '调用CheckDomain检查域名是否可以注册。',
'description' => '有关域名的合法性要求,请参见[域名合法性](~~67788~~)。'."\n"
."\n"
.'> 调用CheckDomain接口时有频率限制,同一阿里云账号(主账号)及其RAM用户(子账号)调用该接口的限制为10QPS,接口总量限制为100QPS。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'FuzzyMatchDomainSensitiveWord' => [
'summary' => '调用FuzzyMatchDomainSensitiveWord检查域名是否包含敏感词。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '域名关键字(除域名后缀外包含的词语),多个域名关键字之间使用英文逗号(,)分隔。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'xxx**',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息的语言。取值范围:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Exist' => [
'description' => '域名是否包含敏感词。取值:'."\n"
.'- **true**:含敏感词。'."\n"
.'- **false**:不含敏感词。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D15F91FD-0B34-4E48-8CBF-EFA5D2A31586',
],
'Keyword' => [
'description' => '传入的域名关键字。',
'type' => 'string',
'example' => 'xxx**',
],
'MatchedSentiveWords' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MatchedSensitiveWord' => [
'description' => '匹配到域名中包含敏感词的结果详情。当**Exist**参数的取值为**false**时,匹配结果为空。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Word' => [
'description' => '匹配到域名中包含的敏感词。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Exist\\": true,\\n \\"RequestId\\": \\"D15F91FD-0B34-4E48-8CBF-EFA5D2A31586\\",\\n \\"Keyword\\": \\"xxx**\\",\\n \\"MatchedSentiveWords\\": {\\n \\"MatchedSensitiveWord\\": [\\n {\\n \\"Word\\": \\"xxx\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\",\\n \\"DomainName\\": \\"abc.com\\",\\n \\"Exist\\": true,\\n \\"MatchedSentiveWords\\": [\\n MatchedSentiveWord:{\\n \\"Word\\":\\"ab\\"\\n }\\n ]\\n}"},{"type":"xml","example":"\\n \\n \\n xxx\\n \\n \\n xxx**.cn\\n D15F91FD-0B34-4E48-8CBF-EFA5D2A31586\\n true\\n","errorExample":"\\n BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\n abc.com\\n true\\n \\n \\n ab\\n \\n \\n"}]',
'title' => '检查域名是否包含敏感词',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BatchFuzzyMatchDomainSensitiveWord' => [
'summary' => '调用BatchFuzzyMatchDomainSensitiveWord批量检查域名是否包含敏感词。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '域名关键字,多个域名关键字之间用英文逗号(,)分隔。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com,aliyundoc.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C560A803-B975-481D-A66B-A4395EA863A1',
],
'SensitiveWordMatchResultList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SensitiveWordMatchResult' => [
'description' => '批量匹配结果列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Keyword' => [
'description' => '传入的域名关键字。',
'type' => 'string',
'example' => 'example.com,aliyundoc.com',
],
'Exist' => [
'description' => '域名是否包含敏感词。取值:'."\n"
.'- **true**:含敏感词。'."\n"
.'- **false**:不含敏感词。',
'type' => 'boolean',
'example' => 'true',
],
'MatchedSentiveWords' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MatchedSensitiveWord' => [
'description' => '匹配结果详情。当**Exist**参数的取值为**false**时,匹配结果为空。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Word' => [
'description' => '匹配到的敏感词。',
'type' => 'string',
'example' => 'xxx',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C560A803-B975-481D-A66B-A4395EA863A1\\",\\n \\"SensitiveWordMatchResultList\\": {\\n \\"SensitiveWordMatchResult\\": [\\n {\\n \\"Keyword\\": \\"example.com,aliyundoc.com\\",\\n \\"Exist\\": true,\\n \\"MatchedSentiveWords\\": {\\n \\"MatchedSensitiveWord\\": [\\n {\\n \\"Word\\": \\"xxx\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"C560A803-B975-481D-A66B-A4395EA863A1\\n\\n \\n true\\n example.com\\n \\n \\n xxx\\n \\n \\n \\n \\n true\\n aliyundoc.com\\n \\n \\n xxx\\n \\n \\n \\n","errorExample":"\\n BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\n \\n \\n abc.com\\n true\\n \\n \\n ab\\n \\n \\n \\n \\n cbc.com\\n false\\n \\n"}]',
'title' => '批量检查域名是否包含敏感词',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetupDomainAutoRenew' => [
'summary' => '您可以调用该接口设置或取消域名自动续费。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Operation',
'in' => 'query',
'schema' => [
'description' => '操作类型',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
'SET' => '设置自动续费',
'CANCEL' => '取消自动续费',
],
'example' => 'SET',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例ID',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'S2019270W570xxxx',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'result',
'description' => 'result',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => '8fc97e44-837a-447d-ac61-ea28d2fe8a38',
],
'Result' => [
'description' => '是否成功',
'type' => 'boolean',
'enumValueTitles' => [
'true' => '成功',
'false' => '失败',
],
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8fc97e44-837a-447d-ac61-ea28d2fe8a38\\",\\n \\"Result\\": true\\n}","type":"json"}]',
'title' => '设置或取消域名自动续费',
'description' => '该接口目前仅支持中国站域名。'."\n"
."\n"
.'**请确保在使用该接口前,已充分了解域名产品的收费方式和[价格](https://wanwang.aliyun.com/help/price.html?spm=5176.22941859.J_9989412330.10.68a51838KnzTeD)。**',
],
'SaveRegistrantProfile' => [
'summary' => '调用SaveRegistrantProfile接口创建或更新域名信息模板。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DefaultRegistrantProfile',
'in' => 'query',
'schema' => [
'description' => '是否设置为默认模板。取值:'."\n"
.'- **true**:默认模板。'."\n"
.'- **false**:非默认模板。'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'Country',
'in' => 'query',
'schema' => [
'description' => '国家代码,例如**CN**代表中国,**US**代表美国。',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '信息模板编号,信息模板创建成功后由系统自动生成。'."\n"
."\n"
.'> 更新信息模板时必须传入该参数。信息模板创建成功后您可以调用[QueryRegistrantProfiles](~~QueryRegistrantProfiles~~)接口查询信息模板编号。'."\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '3600000',
],
],
[
'name' => 'City',
'in' => 'query',
'schema' => [
'description' => '城市(英文),填写域名持有者所在城市名称。'."\n"
."\n"
.'> 填写城市名称,需包括“市”,例如,持有者在杭州市,则本参数需填写为“hang zhou shi”。',
'type' => 'string',
'required' => false,
'example' => 'hang zhou shi',
],
],
[
'name' => 'RegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(英文)。',
'type' => 'string',
'required' => false,
'example' => 'li si',
],
],
[
'name' => 'RegistrantName',
'in' => 'query',
'schema' => [
'description' => '联系人名称(英文)。',
'type' => 'string',
'required' => false,
'example' => 'li si',
],
],
[
'name' => 'Province',
'in' => 'query',
'schema' => [
'description' => '省份(英文),填写域名持有者所在省份名称。'."\n"
."\n"
.'> 填写省份名称,无需填写“省”,例如,持有者在浙江省,则本参数填写“zhe jiang”即可。',
'type' => 'string',
'required' => false,
'example' => 'zhe jiang',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'description' => '详细地址(英文)。',
'type' => 'string',
'required' => false,
'example' => 'zhe jiang sheng hang zhou shi shi li qu shi li zhen shi li da sha 1001 hao',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '电子邮箱。',
'type' => 'string',
'required' => false,
'example' => 'username@example.com',
],
],
[
'name' => 'PostalCode',
'in' => 'query',
'schema' => [
'description' => '邮政编码。',
'type' => 'string',
'required' => false,
'example' => '310024',
],
],
[
'name' => 'TelArea',
'in' => 'query',
'schema' => [
'description' => '电话国家代码,例如中国的电话国家代码为**86**。 ',
'type' => 'string',
'required' => false,
'example' => '86',
],
],
[
'name' => 'Telephone',
'in' => 'query',
'schema' => [
'description' => '电话号码。',
'type' => 'string',
'required' => false,
'example' => '1829756****',
],
],
[
'name' => 'TelExt',
'in' => 'query',
'schema' => [
'description' => '分机号码。',
'type' => 'string',
'required' => false,
'example' => '1234',
],
],
[
'name' => 'ZhRegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(中文)。',
'type' => 'string',
'required' => false,
'example' => '李四',
],
],
[
'name' => 'ZhRegistrantName',
'in' => 'query',
'schema' => [
'description' => '联系人名称(中文)。',
'type' => 'string',
'required' => false,
'example' => '李四',
],
],
[
'name' => 'ZhProvince',
'in' => 'query',
'schema' => [
'description' => '省份(中文),填写域名持有者所在省份名称。'."\n"
."\n"
.'> 填写省份名称,无需填写“省”,例如,持有者在浙江省,则本参数填写“浙江”即可。',
'type' => 'string',
'required' => false,
'example' => '浙江',
],
],
[
'name' => 'ZhAddress',
'in' => 'query',
'schema' => [
'description' => '详细地址(中文)。',
'type' => 'string',
'required' => false,
'example' => '浙江省杭州市示例区示例镇示例大厦1001号',
],
],
[
'name' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '城市(中文),填写域名持有者所在城市名称。'."\n"
."\n"
.'> 填写城市名称,需包括“市”,例如,持有者在杭州市,则本参数需填写为“杭州市”。',
'type' => 'string',
'required' => false,
'example' => '杭州市',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '域名持有者类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。'."\n"
."\n"
.'默认值为**1**。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RegistrantProfileType',
'in' => 'query',
'schema' => [
'description' => '信息模板类型。取值:'."\n"
.'- **common**:通用模板。'."\n"
.'- **cnnic**:cnnic模板。'."\n"
."\n"
.'> cnnic模板仅国际站支持。在阿里云国际站注册的“.cn”、“.中国”等CNNIC注册局下的域名需使用cnnic模板,其他域名使用通用模板。',
'type' => 'string',
'required' => false,
'example' => 'common',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RegistrantProfileId' => [
'description' => '信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'example' => '3600000',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D09B153B-294D-42F1-BB61-F1C72136DFD3',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RegistrantProfileId\\": 3600000,\\n \\"RequestId\\": \\"D09B153B-294D-42F1-BB61-F1C72136DFD3\\"\\n}","errorExample":"{\\n \\"RegistrantProfileId\\": \\"3696573\\",\\n \\"RequestId\\": \\"ECB708B9-A82E-45D7-A230-58231E532A57\\"\\n}"},{"type":"xml","example":"\\n 3600000\\n D09B153B-294D-42F1-BB61-F1C72136DFD3\\n","errorExample":"\\n\\n 3600000\\n D09B153B-294D-42F1-BB61-F1C72136DFD3\\n"}]',
'title' => '创建或更新域名信息模板',
'description' => '域名信息模板中包含了域名持有者信息。当您创建或更新信息模板时,域名持有者信息建议根据实际情况都填写并且中英文保持一致。为避免注册局对接审核出错,建议持有者英文信息均使用小写字母填写,具体填写要求可查看下方的参数描述。'."\n"
."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteRegistrantProfile' => [
'summary' => '调用DeleteRegistrantProfile接口删除指定的域名信息模板。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '待删除的信息模板的编号。您可以调用[QueryRegistrantProfiles](~~67701~~)接口查询信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '3600000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C50E41A0-09F1-4491-8DB8-AF55BD2D0CC8',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C50E41A0-09F1-4491-8DB8-AF55BD2D0CC8\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n C50E41A0-09F1-4491-8DB8-AF55BD2D0CC8\\r\\n","errorExample":""}]',
'title' => '删除指定的域名信息模板',
'description' => '> 接口调用成功系统会立即删除对应的信息模板。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteContactTemplates' => [
'summary' => '批量删除域名联系人模板。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'RegistrantProfileIds',
'in' => 'query',
'schema' => [
'description' => '待删除的信息模板的编号,传入多个值时使用逗号(,)分隔。'."\n"
."\n"
.'信息模板创建成功后由系统自动生成,您可以调用[QueryRegistrantProfiles](~~67701~~)接口查询信息模板编号。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123,45,67',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4D73432C-7600-4779-ACBB-C3B5CA145D32',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D73432C-7600-4779-ACBB-C3B5CA145D32\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n4D73432C-7600-4779-ACBB-C3B5CA145D32\\r\\n","errorExample":""}]',
'title' => '删除联系人模板',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RegistrantProfileRealNameVerification' => [
'summary' => '调用RegistrantProfileRealNameVerification接口提交信息模板实名认证。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileID',
'in' => 'query',
'schema' => [
'description' => '待实名认证的信息模板的编号。信息模板创建成功后由系统自动生成,您可以调用[QueryRegistrantProfiles](~~67701~~)接口查询信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
],
[
'name' => 'IdentityCredential',
'in' => 'formData',
'schema' => [
'description' => '上传采用Base64编码的实名认证资料图片。图片要求如下:'."\n"
.'- 图片格式为**JPG**或**BMP**。'."\n"
.'- 原图片大小为**55KB~1MB**。',
'type' => 'string',
'required' => true,
'example' => 'dGVzdA==',
],
],
[
'name' => 'IdentityCredentialNo',
'in' => 'query',
'schema' => [
'description' => '填写实名认证证件号码。'."\n"
."\n"
.'例如身份证号码、营业执照号码等,证件号码需要与实名认证证件上的号码完全一致。企业类的证件需填写证件上的**18位**统一社会信用代码。',
'type' => 'string',
'required' => true,
'example' => '43012512345678****',
],
],
[
'name' => 'IdentityCredentialType',
'in' => 'query',
'schema' => [
'description' => '实名认证证件类型,选择您用于实名认证的证件类型。取值:'."\n"
.'- **SFZ**:身份证。'."\n"
.'- **HZ**:护照。'."\n"
.'- **YYZZ**:营业执照。'."\n"
.'- **ORG**:组织机构代码证。'."\n"
.'- **XYDM**:统一社会信用代码证书。'."\n"
.'- **TXZ**:港澳居民来往内地通行证。'."\n"
."\n"
.'> 更多证件类型的取值请参见[支持实名认证的证件类型](~~72209~~)。',
'type' => 'string',
'required' => true,
'example' => 'SFZ',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '51D584A2-0CCD-4336-AD7D-1AD4C67B5545',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"51D584A2-0CCD-4336-AD7D-1AD4C67B5545\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"51D584A2-0CCD-4336-AD7D-1AD4C67B5545\\"\\n}"},{"type":"xml","example":"\\n 51D584A2-0CCD-4336-AD7D-1AD4C67B5545\\n","errorExample":"\\n\\n 51D584A2-0CCD-4336-AD7D-1AD4C67B5545\\n"}]',
'title' => '提交信息模板实名认证',
'description' => '- 实名认证材料审核需要3~5个工作日,待审核机构完成审核后,您可以调用[QueryRegistrantProfiles](~~67701~~)接口查询实名认证审核结果。'."\n"
.'- 如果实名认证审核失败,请参见[实名认证失败原因及解决方案](~~35885~~)进行排查处理。'."\n"
."\n"
.'> 该接口必须采用POST方式调用,否则会调用失败。使用SDK调用时,请设置request对象的**method**参数为**POST**。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDefaultRegistrantProfile' => [
'summary' => '调用SetDefaultRegistrantProfile接口设置域名联系人默认模板。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,默认设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '待设置的信息模板的编号。'."\n"
."\n"
.'信息模板创建成功后由系统自动生成,您可以调用[QueryRegistrantProfiles](~~67701~~)接口查询信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1234567',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4D73432C-7600-4779-ACBB-C3B5CA145D32',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D73432C-7600-4779-ACBB-C3B5CA145D32\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n4D73432C-7600-4779-ACBB-C3B5CA145D32\\r\\n","errorExample":""}]',
'title' => '设置默认联系人信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainAdminDivision' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '4EA05A10-D4BC-47EA-AD9E-370A46BB4FB9',
],
'AdminDivisions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AdminDivision' => [
'description' => '一级行政区划。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DivisionName' => [
'description' => '行政区划名称。',
'type' => 'string',
'example' => '河北',
],
'Children' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Children' => [
'description' => '下级行政区划。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ChildDivisionName' => [
'description' => '下级行政区划名称。',
'type' => 'string',
'example' => '石家庄',
],
],
],
],
],
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4EA05A10-D4BC-47EA-AD9E-370A46BB4FB9\\",\\n \\"AdminDivisions\\": {\\n \\"AdminDivision\\": [\\n {\\n \\"DivisionName\\": \\"河北\\",\\n \\"Children\\": {\\n \\"Children\\": [\\n {\\n \\"ChildDivisionName\\": \\"石家庄\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","errorExample":"{\\n\\"requestId\\": \\"0F1B3547-BE50-4206-8F78-9540FFB85BC1\\",\\n\\"adminDivisions\\"[]\\n}"},{"type":"xml","example":"\\n CD1D8BF9-6FA1-4840-A9F0-29B7E963152F\\n \\n \\n 北京\\n \\n \\n 市辖区\\n \\n \\n \\n \\n 天津\\n \\n \\n 市辖区\\n \\n \\n \\n \\n 河北\\n \\n \\n 石家庄市\\n \\n \\n 唐山市\\n \\n \\n 秦皇岛市\\n \\n \\n 邯郸市\\n \\n \\n 邢台市\\n \\n \\n 保定市\\n \\n \\n 张家口市\\n \\n \\n 承德市\\n \\n \\n 沧州市\\n \\n \\n 廊坊市\\n \\n \\n 衡水市\\n \\n \\n \\n \\n","errorExample":"\\n\\n\\n0F1B3547-BE50-4206-8F78-9540FFB85BC1\\n"}]',
'title' => '查询中国行政区划',
'summary' => '调用QueryDomainAdminDivision查询中国行政区划。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFailReasonForRegistrantProfileRealNameVerification' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileID',
'in' => 'query',
'schema' => [
'description' => '实名认证失败的信息模板编号。您可以调用[QueryRegistrantProfiles](~~67701~~)接口查询信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '548C407F-AEA2-4B5D-90DF-EC11EBB1D76F',
],
'Data' => [
'description' => '实名认证审核失败原因列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => [
'description' => '审核日期。',
'type' => 'string',
'example' => '2017-03-17 11:08:02',
],
'FailReason' => [
'description' => '实名认证审核失败的原因。'."\n"
."\n"
.'实名认证审核失败后的处理方法,请参见[实名认证失败原因及解决方案](~~35885~~)。',
'type' => 'string',
'example' => '证件电子信息核验不合格',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"548C407F-AEA2-4B5D-90DF-EC11EBB1D76F\\",\\n \\"Data\\": [\\n {\\n \\"Date\\": \\"2017-03-17 11:08:02\\",\\n \\"FailReason\\": \\"证件电子信息核验不合格\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Data\\": {\\n \\"FailRecord\\": [\\n {\\n \\"FailReason\\": \\"审核失败,所有者(中文)字段必须包含中文字符。\\",\\n \\"Date\\": \\"2017-03-17 11:08:02\\"\\n },\\n {\\n \\"FailReason\\": \\"请上传55K-1M的jpg或者bmp图片\\",\\n \\"Date\\": \\"2017-03-16 20:55:02\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1F1BA893-AD33-4248-8CB8-1657E3733052\\"\\n}"},{"type":"xml","example":"\\n548C407F-AEA2-4B5D-90DF-EC11EBB1D76F\\n\\n 证件电子信息核验不合格\\n 2020-06-23 09:52:31\\n\\n","errorExample":"\\n\\n \\n \\n 审核失败,所有者(中文)字段必须包含中文字符。\\n 2017-03-17 11:08:02\\n \\n \\n 请上传55K-1M的jpg或者bmp图片\\n 2017-03-16 20:55:02\\n \\n \\n 1F1BA893-AD33-4248-8CB8-1657E3733052\\n"}]',
'title' => '查询信息模板实名认证审核失败的原因',
'summary' => '调用QueryFailReasonForRegistrantProfileRealNameVerification接口查询信息模板实名认证审核失败的原因。',
'requestParamsDescription' => ' ',
'extraInfo' => ' ',
],
'VerifyContactField' => [
'summary' => '部分参数是否必传将根据注册局要求而定。该API是对输入参数合规,合法性进行校验,并不与域名信息进行对比校验。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Province',
'in' => 'query',
'schema' => [
'description' => '省份(英文)。',
'type' => 'string',
'required' => false,
'example' => 'Bei jing',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'City',
'in' => 'query',
'schema' => [
'description' => '城市(英文)。',
'type' => 'string',
'required' => false,
'example' => 'Bei jing',
],
],
[
'name' => 'RegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(英文)。',
'type' => 'string',
'required' => false,
'example' => 'wang xian sheng',
],
],
[
'name' => 'Country',
'in' => 'query',
'schema' => [
'description' => '国家代码,例如**CN**、**US**。',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
],
[
'name' => 'RegistrantName',
'in' => 'query',
'schema' => [
'description' => '联系人名称(英文)。',
'type' => 'string',
'required' => false,
'example' => 'wang xian sheng',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'description' => '详细地址(英文)。',
'type' => 'string',
'required' => false,
'example' => 'Rd. xitucheng',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '电子邮箱。',
'type' => 'string',
'required' => false,
'example' => 'username@example.com',
],
],
[
'name' => 'PostalCode',
'in' => 'query',
'schema' => [
'description' => '邮政编码。',
'type' => 'string',
'required' => false,
'example' => '100000',
],
],
[
'name' => 'TelArea',
'in' => 'query',
'schema' => [
'description' => '电话国家代码,例如中国的电话国家代码为**86**。',
'type' => 'string',
'required' => false,
'example' => '86',
],
],
[
'name' => 'Telephone',
'in' => 'query',
'schema' => [
'description' => '电话。',
'type' => 'string',
'required' => false,
'example' => '1390000****',
],
],
[
'name' => 'TelExt',
'in' => 'query',
'schema' => [
'description' => '分机号码。',
'type' => 'string',
'required' => false,
'example' => '01',
],
],
[
'name' => 'ZhRegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。',
'type' => 'string',
'required' => false,
'example' => '王先生',
],
],
[
'name' => 'ZhRegistrantName',
'in' => 'query',
'schema' => [
'description' => '联系人名称(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。',
'type' => 'string',
'required' => false,
'example' => '王先生',
],
],
[
'name' => 'ZhProvince',
'in' => 'query',
'schema' => [
'description' => '省份(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。',
'type' => 'string',
'required' => false,
'example' => '北京',
],
],
[
'name' => 'ZhAddress',
'in' => 'query',
'schema' => [
'description' => '详细地址(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。',
'type' => 'string',
'required' => false,
'example' => '西土城路',
],
],
[
'name' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '城市(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。',
'type' => 'string',
'required' => false,
'example' => '北京市',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '域名持有者类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'example.com',
'default' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'ABAC3BAC-FCFA-4DAE-B47C-FA4105CB07C6',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ABAC3BAC-FCFA-4DAE-B47C-FA4105CB07C6\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"ABAC3BAC-FCFA-4DAE-B47C-FA4105CB07C6\\"\\n}"},{"type":"xml","example":"\\n ABAC3BAC-FCFA-4DAE-B47C-FA4105CB07C6\\n","errorExample":"\\n 30EEA1A7-3C86-471B-BFD8-5AF13CBE0CD3\\n"}]',
'title' => '校验域名联系人信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRegistrantProfiles' => [
'summary' => '调用QueryRegistrantProfiles接口查询当前账号下的域名信息模板。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain7EGRPF',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(英文)。',
'type' => 'string',
'required' => false,
'example' => 'li si',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '待查询的信息模板的编号,信息模板创建成功后由系统自动生成。'."\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1234567',
],
],
[
'name' => 'DefaultRegistrantProfile',
'in' => 'query',
'schema' => [
'description' => '是否为默认模板。取值:'."\n"
.'- **true**:默认模板。'."\n"
.'- **false**:非默认模板。'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '分页的页码,默认值为**0**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页记录数。默认值为**0**,最大值为**5000**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '500',
'default' => '500',
],
],
[
'name' => 'ZhRegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(中文)。',
'type' => 'string',
'required' => false,
'example' => '李四',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '域名持有者类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。'."\n"
."\n"
.'默认值为**1**。'."\n"
.' ',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RealNameStatus',
'in' => 'query',
'schema' => [
'description' => '实名认证状态。取值:'."\n"
.'- **FAILED**:实名认证失败。'."\n"
.'- **SUCCEED**:实名认证成功。'."\n"
.'- **NONAUDIT**:未实名认证。'."\n"
.'- **AUDITING**:审核中。'."\n"
.' ',
'type' => 'string',
'required' => false,
'example' => 'SUCCEED',
'enum' => [
'FAILED',
'SUCCEED',
'NONAUDIT',
'AUDITING',
],
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '电子邮箱。',
'type' => 'string',
'required' => false,
'example' => 'username@example.com',
],
],
[
'name' => 'RegistrantProfileType',
'in' => 'query',
'schema' => [
'description' => '信息模板类型。取值:'."\n"
.'- **common**:通用模板。'."\n"
.'- **cnnic**:cnnic模板。'."\n"
."\n"
.'> cnnic模板仅国际站支持,在阿里云国际站注册的“.cn”、“.中国”等CNNIC注册局下的域名需使用cnnic模板,其他域名使用通用模板。',
'type' => 'string',
'required' => false,
'example' => 'common',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注。',
'type' => 'string',
'required' => false,
'example' => '测试域名',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextPage' => [
'description' => '是否有下一页。取值:'."\n"
.'- **true**:有。'."\n"
.'- **false**:没有。',
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '94053D79-7455-4F71-BF06-20EB2DEDE6BD',
],
'TotalItemNum' => [
'description' => '总记录数。'."\n"
."\n"
.'> 总记录数是指查询出来的信息模板的数量。当有多个信息模板时,一个信息模板显示完了会接着显示第二个信息模板。',
'type' => 'integer',
'format' => 'int32',
'example' => '9',
],
'PrePage' => [
'description' => '是否有上一页。取值:'."\n"
.'- **true**:有。'."\n"
.'- **false**:没有。',
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPageNum' => [
'description' => '总页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '每页记录数。默认值为**0**,最大值为**5000**。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'RegistrantProfiles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RegistrantProfile' => [
'description' => '域名信息模板列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TelExt' => [
'description' => '分机号码。',
'type' => 'string',
'example' => '1234',
],
'UpdateTime' => [
'description' => '信息模板更新时间。',
'type' => 'string',
'example' => '2019-03-15 15:32:45',
],
'ZhProvince' => [
'description' => '省份(中文)。',
'type' => 'string',
'example' => '浙江',
],
'CreateTime' => [
'description' => '信息模板创建时间。',
'type' => 'string',
'example' => '2019-02-18 10:46:47',
],
'Telephone' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '1829756****',
],
'RegistrantOrganization' => [
'description' => '域名持有者名称(英文)。',
'type' => 'string',
'example' => 'li si',
],
'City' => [
'description' => '城市(英文)。',
'type' => 'string',
'example' => 'hang zhou shi',
],
'ZhCity' => [
'description' => '城市(中文)。',
'type' => 'string',
'example' => '杭州市',
],
'TelArea' => [
'description' => '电话国家代码,例如中国的电话国家代码为**86**。 ',
'type' => 'string',
'example' => '86',
],
'Address' => [
'description' => '详细地址(英文)。',
'type' => 'string',
'example' => 'zhe jiang sheng hang zhou shi shi li qu shi li zhen shi li da sha 1001 hao',
],
'RealNameStatus' => [
'description' => '实名认证状态。取值:'."\n"
.'- **FAILED**:实名认证失败。'."\n"
.'- **SUCCEED**:实名认证成功。'."\n"
.'- **NONAUDIT**:未实名认证。'."\n"
.'- **AUDITING**:审核中。'."\n",
'type' => 'string',
'example' => 'SUCCEED',
],
'PostalCode' => [
'description' => '邮政编码。',
'type' => 'string',
'example' => '310024',
],
'RegistrantProfileType' => [
'description' => '信息模板类型。取值:'."\n"
.'- **common**:通用模板。'."\n"
.'- **cnnic**:cnnic模板。'."\n"
."\n"
.'> cnnic模板仅国际站支持,在阿里云国际站注册的“.cn”、“.中国”等CNNIC注册局下的域名需使用cnnic模板,其他域名使用通用模板。',
'type' => 'string',
'example' => 'common',
],
'RegistrantProfileId' => [
'description' => '查询到的信息模板的编号。',
'type' => 'integer',
'format' => 'int64',
'example' => '1000001',
],
'ZhRegistrantOrganization' => [
'description' => '域名持有者名称(中文)。',
'type' => 'string',
'example' => '李四',
],
'DefaultRegistrantProfile' => [
'description' => '是否为默认模板。取值:'."\n"
.'- **true**:默认模板。'."\n"
.'- **false**:非默认模板。'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'example' => 'false',
],
'Email' => [
'description' => '电子邮箱。',
'type' => 'string',
'example' => '82106****@qq.com',
],
'ZhRegistrantName' => [
'description' => '联系人名称(中文)。',
'type' => 'string',
'example' => '李四',
],
'RegistrantType' => [
'description' => '域名持有者类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。'."\n"
."\n"
.'默认值为**1**。 ',
'type' => 'string',
'example' => '1',
],
'Country' => [
'description' => '国家代码,例如**CN**代表中国,**US**代表美国。',
'type' => 'string',
'example' => 'CN',
],
'RegistrantName' => [
'description' => '联系人名称(英文)。',
'type' => 'string',
'example' => 'li si',
],
'EmailVerificationStatus' => [
'description' => '邮箱验证状态。取值:'."\n"
.'- **0**:未验证。'."\n"
.'- **1**:已验证。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ZhAddress' => [
'description' => '详细地址(中文)。',
'type' => 'string',
'example' => '浙江省杭州市示例区示例镇示例大厦1001号',
],
'Province' => [
'description' => '省份(英文)。',
'type' => 'string',
'example' => 'zhe jiang',
],
'CredentialNo' => [
'description' => '证件号',
'type' => 'string',
'example' => '4****************1',
],
'CredentialType' => [
'description' => '证件类型',
'type' => 'string',
'example' => 'YYZZ',
],
'Remark' => [
'description' => '备注。',
'type' => 'string',
'example' => '测试域名',
],
'Params' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextPage\\": true,\\n \\"RequestId\\": \\"94053D79-7455-4F71-BF06-20EB2DEDE6BD\\",\\n \\"TotalItemNum\\": 9,\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 1,\\n \\"TotalPageNum\\": 1,\\n \\"PageSize\\": 2,\\n \\"RegistrantProfiles\\": {\\n \\"RegistrantProfile\\": [\\n {\\n \\"TelExt\\": \\"1234\\",\\n \\"UpdateTime\\": \\"2019-03-15 15:32:45\\",\\n \\"ZhProvince\\": \\"浙江\\",\\n \\"CreateTime\\": \\"2019-02-18 10:46:47\\",\\n \\"Telephone\\": \\"1829756****\\",\\n \\"RegistrantOrganization\\": \\"li si\\",\\n \\"City\\": \\"hang zhou shi\\",\\n \\"ZhCity\\": \\"杭州市\\",\\n \\"TelArea\\": \\"86\\",\\n \\"Address\\": \\"zhe jiang sheng hang zhou shi shi li qu shi li zhen shi li da sha 1001 hao\\",\\n \\"RealNameStatus\\": \\"SUCCEED\\",\\n \\"PostalCode\\": \\"310024\\",\\n \\"RegistrantProfileType\\": \\"common\\",\\n \\"RegistrantProfileId\\": 1000001,\\n \\"ZhRegistrantOrganization\\": \\"李四\\",\\n \\"DefaultRegistrantProfile\\": false,\\n \\"Email\\": \\"82106****@qq.com\\",\\n \\"ZhRegistrantName\\": \\"李四\\",\\n \\"RegistrantType\\": \\"1\\",\\n \\"Country\\": \\"CN\\",\\n \\"RegistrantName\\": \\"li si\\",\\n \\"EmailVerificationStatus\\": 1,\\n \\"ZhAddress\\": \\"浙江省杭州市示例区示例镇示例大厦1001号\\",\\n \\"Province\\": \\"zhe jiang\\",\\n \\"CredentialNo\\": \\"4****************1\\",\\n \\"CredentialType\\": \\"YYZZ\\",\\n \\"Remark\\": \\"测试域名\\",\\n \\"Params\\": \\"\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"CurrentPageNum\\": 1,\\n \\"NextPage\\": true,\\n \\"PageSize\\": 2,\\n \\"PrePage\\": false,\\n \\"RegistrantProfiles\\": {\\n \\"RegistrantProfile\\": [\\n {\\n \\"Address\\": \\"aqqqq\\",\\n \\"City\\": \\"us\\",\\n \\"Country\\": \\"US\\",\\n \\"CreateTime\\": \\"Dec 25,2017 03:20:30\\",\\n \\"DefaultRegistrantProfile\\": true,\\n \\"Email\\": \\"a@xxx.com\\",\\n \\"EmailVerificationStatus\\": 0,\\n \\"PostalCode\\": \\"010101\\",\\n \\"Province\\": \\"qa\\",\\n \\"RegistrantName\\": \\"x\\",\\n \\"RegistrantOrganization\\": \\"xxx\\",\\n \\"RegistrantProfileId\\": 5170612,\\n \\"TelArea\\": \\"010\\",\\n \\"Telephone\\": \\"11119999\\",\\n \\"UpdateTime\\": \\"Dec 25,2017 03:21:59\\"\\n },\\n {\\n \\"Address\\": \\"xx District\\",\\n \\"City\\": \\"Beijing\\",\\n \\"Country\\": \\"MO\\",\\n \\"CreateTime\\": \\"Nov 22,2017 09:20:40\\",\\n \\"DefaultRegistrantProfile\\": false,\\n \\"Email\\": \\"abctest@xxx.com\\",\\n \\"EmailVerificationStatus\\": 0,\\n \\"PostalCode\\": \\"100086\\",\\n \\"Province\\": \\"Beijing\\",\\n \\"RegistrantName\\": \\"lk\\",\\n \\"RegistrantOrganization\\": \\"lk\\",\\n \\"RegistrantProfileId\\": 5049715,\\n \\"TelArea\\": \\"853\\",\\n \\"Telephone\\": \\"15600000000\\",\\n \\"UpdateTime\\": \\"Nov 22,2017 09:20:40\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8843D641-7520-4399-9FCC-BFB90C068E6F\\",\\n \\"TotalItemNum\\": 11,\\n \\"TotalPageNum\\": 6\\n}"},{"type":"xml","example":"\\r\\n 9\\r\\n 500\\r\\n 1\\r\\n 94053D79-7455-4F71-BF06-20EB2DEDE6BD\\r\\n false\\r\\n \\r\\n \\r\\n 杭州市\\r\\n 李四\\r\\n 1829756****\\r\\n 浙江\\r\\n false\\r\\n 1\\r\\n 2019-03-15 15:32:45\\r\\n SUCCEED\\r\\n CN\\r\\n zhe jiang\\r\\n 李四\\r\\n hang zhou shi\\r\\n 86\\r\\n 1000001\\r\\n 310024\\r\\n 1\\r\\n username@example.com\\r\\n 2019-02-18 10:46:47\\r\\n zhe jiang sheng hang zhou shi shi li qu shi li zhen shi li da sha 1001 hao\\r\\n li si\\r\\n li si\\r\\n common\\r\\n 浙江省杭州市示例区示例镇示例大厦1001号\\r\\n \\r\\n \\r\\n 1\\r\\n false\\r\\n","errorExample":"\\n\\n 11\\n 2\\n 1\\n 1200F9CE-0000-4C5F-86C2-F8CF3828670D\\n false\\n \\n \\n 11119999\\n true\\n 0\\n Dec 25,2017 03:21:59\\n US\\n qa\\n 010\\n us\\n 5170612\\n 010101\\n xxx@xxx.com\\n Dec 25,2017 03:20:30\\n aqqqq\\n pop\\n popus-x\\n \\n \\n 15600000000\\n false\\n 0\\n Nov 22,2017 09:20:40\\n MO\\n Beijing\\n 853\\n Beijing\\n 5049715\\n 100086\\n abctest@xx.com\\n Nov 22,2017 09:20:40\\n Chaoyang District\\n lk\\n lk\\n \\n \\n 6\\n true\\n"}]',
'title' => '查询当前账号下的域名信息模板',
'description' => '您可以选择传入非必选参数,帮助您更精确的查找信息模板。例如:'."\n"
.'- 您已经知道信息模板的编号,您可以传入信息模板编号,查询详细的模板信息。'."\n"
.'- 您不知道信息模板的编号,您可以传入域名持有者名称等参数,查询详细的模板信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRegistrantProfileRealNameVerificationInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '待查询的信息模板的编号。'."\n"
."\n"
.'信息模板创建成功后由系统自动生成,您可以调用[QueryRegistrantProfiles](~~67701~~)接口查询信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
],
[
'name' => 'FetchImage',
'in' => 'query',
'schema' => [
'description' => '是否获取实名认证图片信息。取值:'."\n"
.'- **true**:获取。'."\n"
.'- **false**:不获取。'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'IdentityCredentialType' => [
'description' => '实名认证证件类型。取值:'."\n"
.'- **SFZ**:身份证。'."\n"
.'- **HZ**:护照。'."\n"
.'- **YYZZ**:营业执照。'."\n"
.'- **ORG**:组织机构代码证。'."\n"
.'- **XYDM**:统一社会信用代码证书。'."\n"
.'- **TXZ**:港澳居民来往内地通行证。'."\n"
."\n"
.'> 更多证件类型的取值请参见[支持实名认证的证件类型](~~72209~~)。',
'type' => 'string',
'example' => 'SFZ',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4D73432C-7600-4779-ACBB-C3B5CA145D32',
],
'ModificationDate' => [
'description' => '实名认证资料更新时间。',
'type' => 'string',
'example' => '2017-05-22 19:04:49',
],
'IdentityCredential' => [
'description' => '采用Base64编码的实名认证资料图片。',
'type' => 'string',
'example' => 'dGVzdA==',
],
'SubmissionDate' => [
'description' => '实名认证资料提交时间。',
'type' => 'string',
'example' => '2017-05-22 19:04:49',
],
'IdentityCredentialNo' => [
'description' => '实名认证证件号码。',
'type' => 'string',
'example' => '4111111111111110**',
],
'RegistrantProfileId' => [
'description' => '查询到的信息模板的编号。',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'IdentityCredentialUrl' => [
'description' => '实名认证图片下载地址。',
'type' => 'string',
'example' => 'http://test.oss-cn-hangzhou.aliyuncs.com/20170522/1219541161213057_070445190.jpg',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IdentityCredential\\": \\"dGVzdA==\\",\\n \\"RequestId\\": \\"4D73432C-7600-4779-ACBB-C3B5CA145D32\\",\\n \\"RegistrantProfileId\\": 1234567,\\n \\"IdentityCredentialNo\\": \\"4111111111111110**\\",\\n \\"SubmissionDate\\": \\"2017-05-22 19:04:49\\",\\n \\"IdentityCredentialUrl\\": \\"http://test.oss-cn-hangzhou.aliyuncs.com/20170522/1219541161213057_070445190.jpg\\",\\n \\"ModificationDate\\": \\"2017-05-22 19:04:49\\",\\n \\"IdentityCredentialType\\": \\"SFZ\\"\\n}","errorExample":"{\\n \\"IdentityCredentialNo\\":\\"411111111111111\\",\\n \\"IdentityCredentialType\\":\\"SFZ\\",\\n \\"ModificationDate\\":\\"2017-05-22 19:04:49\\",\\n \\"RegistrantProfileId\\":123456,\\n \\"RequestId\\":\\"4D73432C-7600-4779-ACBB-C3B5CA145D32\\",\\n \\"SubmissionDate\\":\\"2017-05-22 19:04:49\\"\\n}"},{"type":"xml","example":"\\n\\t4111111111111110**\\n\\tSFZ\\n\\t2017-05-22 19:04:49\\n\\t1234567\\n\\t4D73432C-7600-4779-ACBB-C3B5CA145D32\\n\\t2017-05-22 19:04:49\\n","errorExample":"\\n 123456\\n 175FE8E4-309A-466B-AA84-DE7E2A19C948\\n 2017-05-22 19:04:49\\n SFZ\\n 1234567890123456\\n 2017-05-22 19:04:49\\n"}]',
'title' => '查询信息模板实名认证资料',
'summary' => '调用QueryRegistrantProfileRealNameVerificationInfo接口查询信息模板实名认证资料。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveTaskForSubmittingDomainRealNameVerificationByIdentityCredential' => [
'summary' => '批量提交域名资料',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'default' => 'en',
],
],
[
'name' => 'IdentityCredential',
'in' => 'formData',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'IdentityCredentialNo',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'IdentityCredentialType',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'TaskNo' => [
'type' => 'string',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"errorExample":"{\\n \\"RequestId\\": \\"51D584A2-0CCD-4336-AD7D-1AD4C67B5545\\"\\n}","example":"{\\n\\t\\"RequestId\\":\\"601A42C5-AED3-4952-BBC0-ACC56E699FB6\\",\\n\\t\\"TaskNo\\":\\"f1382d65-bab3-48ae-b61f-6680cc3595bf\\"\\n}","type":"json"},{"errorExample":"\\n\\n 51D584A2-0CCD-4336-AD7D-1AD4C67B5545\\n","example":"\\n\\n 51D584A2-0CCD-4336-AD7D-1AD4C67B5545\\n","type":"xml"}]',
],
'SaveTaskForSubmittingDomainRealNameVerificationByRegistrantProfileID' => [
'summary' => '根据模板保存域名的实名认证信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => true,
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'type' => 'string',
],
'TaskNo' => [
'type' => 'string',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"errorExample":"{ \\n \\"Success\\":true, \\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}","example":"{ \\n \\"Success\\":true, \\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}","type":"json"},{"errorExample":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n","example":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n","type":"xml"}]',
],
'CancelDomainVerification' => [
'summary' => '调用CancelDomainVerification取消域名实名认证审核。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1 ',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号,通过查询域名列表[QueryDomainList](~~67712~~)接口获取。',
'type' => 'string',
'required' => true,
'example' => 'S2019270W570xxxx',
],
],
[
'name' => 'ActionType',
'in' => 'query',
'schema' => [
'description' => '操作类型。取值:'."\n"
.'- **DOMAINAUDIT**:域名审核。'."\n"
.'- **AUDITCONTACT**:审核联系人。',
'type' => 'string',
'required' => true,
'example' => 'AUDITCONTACT',
'enum' => [
'DOMAINAUDIT',
'AUDITCONTACT',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0AC0AF67-D303-4EB9-B20E-B4D4B2C3F97B',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0AC0AF67-D303-4EB9-B20E-B4D4B2C3F97B\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n0AC0AF67-D303-4EB9-B20E-B4D4B2C3F97B\\r\\n","errorExample":""}]',
'title' => '取消域名实名认证审核',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainRealNameVerificationInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'aliyundoc.com',
],
],
[
'name' => 'FetchImage',
'in' => 'query',
'schema' => [
'description' => '是否获取实名认证图片。取值:'."\n"
.'- **true**:获取。'."\n"
.'- **false**:不获取。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'IdentityCredentialType' => [
'description' => '实名认证证件类型。取值:'."\n"
.'- **SFZ**:身份证。'."\n"
.'- **HZ**:护照。'."\n"
.'- **YYZZ**:营业执照。'."\n"
.'- **ORG**:组织机构代码证。'."\n"
.'- **XYDM**:统一社会信用代码证书。'."\n"
.'- **TXZ**:港澳居民来往内地通行证。'."\n"
."\n"
.'如果您使用的证件不在上述范围中,请参见[支持实名认证的证件类型](~~72209~~)章节,查看相应证件类型的取值。'."\n"
.'> 请务必选择与您传入的证件一致的证件类型。',
'type' => 'string',
'example' => 'SFZ',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '4DF9D693-0D5B-4EB7-8922-7ECA6BD59314',
],
'InstanceId' => [
'description' => '实例ID。',
'type' => 'string',
'example' => 'S2019270W570****',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'aliyundoc.com',
],
'IdentityCredential' => [
'description' => '使用Base64编码的实名认证资料图片。图片要求如下:'."\n"
.'- 图片为**jpg**或**bmp**格式。'."\n"
.'- 原图片大小为**55K~1M**。',
'type' => 'string',
'example' => 'dGVzdA==',
],
'SubmissionDate' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'IdentityCredentialNo' => [
'description' => '实名认证资料证件号码,如:身份证号码、统一社会信用代码。',
'type' => 'string',
'example' => '5****************9',
],
'IdentityCredentialUrl' => [
'description' => '实名认证图片下载地址。',
'type' => 'string',
'example' => 'http://dbu-nap-p.oss-cn-hangzhou.aliyuncs.com/20190219/140692647406xxxx_5d6baea3e7314fd986afdd86e33exxxx.jpg',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"IdentityCredential\\": \\"dGVzdA==\\",\\n \\"RequestId\\": \\"4DF9D693-0D5B-4EB7-8922-7ECA6BD59314\\",\\n \\"IdentityCredentialNo\\": \\"5****************9\\",\\n \\"SubmissionDate\\": \\"2018-03-28 00:41:42\\",\\n \\"IdentityCredentialUrl\\": \\"http://dbu-nap-p.oss-cn-hangzhou.aliyuncs.com/20190219/140692647406xxxx_5d6baea3e7314fd986afdd86e33exxxx.jpg\\",\\n \\"InstanceId\\": \\"S2019270W570****\\",\\n \\"DomainName\\": \\"aliyundoc.com\\",\\n \\"IdentityCredentialType\\": \\"SFZ\\"\\n}","errorExample":""},{"type":"xml","example":"SFZ\\n4DF9D693-0D5B-4EB7-8922-7ECA6BD59314\\nS2019270W570****\\naliyundoc.com\\ndGVzdA==\\n2018-03-28 00:41:42\\n5****************9\\nhttp://dbu-nap-p.oss-cn-hangzhou.aliyuncs.com/20190219/140692647406xxxx_5d6baea3e7314fd986afdd86e33exxxx.jpg","errorExample":""}]',
'title' => '查询域名实名认证资料',
'summary' => '调用QueryDomainRealNameVerificationInfo查询域名实名认证资料。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFailReasonForDomainRealNameVerification' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'RealNameVerificationAction',
'in' => 'query',
'schema' => [
'description' => '审核类型。取值:'."\n"
.'- **ACTIVATE**:新注册。'."\n"
.'- **CHGHOLDER**:过户。'."\n"
.'- **TRANSFER**:转入。'."\n"
.' ',
'type' => 'string',
'required' => true,
'example' => 'ACTIVATE',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '1F1BA893-AD33-4248-8CB8-1657E3733052',
],
'Data' => [
'description' => '实名认证失败原因列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => [
'description' => '日期。',
'type' => 'string',
'example' => '2017-03-17 11:08:02',
],
'FailReason' => [
'description' => '实名认证失败原因。',
'type' => 'string',
'example' => '审核失败,所有者(中文)字段必须包含中文字符。',
],
'DomainNameVerificationStatus' => [
'description' => '命名审核状态。取值:'."\n"
.'- **NONAUDIT**:未认证。'."\n"
.'- **SUCCEED**:成功。'."\n"
.'- **FAILED**:审核失败。'."\n"
.'- **AUDITING**:审核中。'."\n"
.' ',
'type' => 'string',
'example' => 'SUCCEED',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1F1BA893-AD33-4248-8CB8-1657E3733052\\",\\n \\"Data\\": [\\n {\\n \\"Date\\": \\"2017-03-17 11:08:02\\",\\n \\"FailReason\\": \\"审核失败,所有者(中文)字段必须包含中文字符。\\",\\n \\"DomainNameVerificationStatus\\": \\"SUCCEED\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"Data\\": {\\n \\"FailRecord\\": [\\n {\\n \\"FailReason\\": \\"审核失败,所有者(中文)字段必须包含中文字符。\\",\\n \\"Date\\": \\"2017-03-17 11:08:02\\",\\n \\"DomainNameVerificationStatus\\": \\"SUCCEED\\"\\n },\\n {\\n \\"FailReason\\": \\"请上传55K-1M的jpg或者bmp图片\\",\\n \\"Date\\": \\"2017-03-16 20:55:02\\",\\n \\"DomainNameVerificationStatus\\": \\"SUCCEED\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1F1BA893-AD33-4248-8CB8-1657E3733052\\"\\n}"},{"type":"xml","example":"\\n \\n 审核失败,所有者(中文)字段必须包含中文字符。\\n 2017-03-17 11:08:02\\n SUCCEED\\n \\n \\n 请上传55KB-1MB的jpg或者bmp图片\\n 2017-03-16 20:55:02\\n SUCCEED\\n \\n\\n1F1BA893-AD33-4248-8CB8-1657E3733052","errorExample":"\\n\\n \\n \\n 审核失败,所有者(中文)字段必须包含中文字符。\\n 2017-03-17 11:08:02\\n SUCCEED\\n \\n \\n 请上传55K-1M的jpg或者bmp图片\\n 2017-03-16 20:55:02\\n SUCCEED\\n \\n \\n 1F1BA893-AD33-4248-8CB8-1657E3733052\\n"}]',
'title' => '查询域名实名认证失败原因',
'summary' => '查询域名实名认证(包括命名审核)失败原因。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteEmailVerification' => [
'summary' => '调用DeleteEmailVerification接口删除已经验证通过的邮箱。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '待删除的邮箱,多个邮箱之间使用英文逗号(,)隔开。',
'type' => 'string',
'required' => true,
'example' => 'test1@aliyun.com,test2@aliyun.com',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7A3D0E4A-0D4B-4BD0-90D7-A61DF8DD26AE',
],
'SuccessList' => [
'description' => '邮箱删除成功列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => '删除成功的邮箱。',
'type' => 'string',
'example' => 'test2@aliyun.com',
],
'Code' => [
'description' => '返回code。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '邮箱删除成功返回的信息。',
'type' => 'string',
'example' => 'Success',
],
],
],
],
'FailList' => [
'description' => '邮箱删除失败列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => '删除失败的邮箱。',
'type' => 'string',
'example' => 'test1@aliyun.com',
],
'Code' => [
'description' => '返回code。',
'type' => 'string',
'example' => 'ParameterIllegall',
],
'Message' => [
'description' => '邮箱删除失败返回的信息。',
'type' => 'string',
'example' => 'Parameter error',
],
],
],
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7A3D0E4A-0D4B-4BD0-90D7-A61DF8DD26AE\\",\\n \\"SuccessList\\": [\\n {\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Success\\",\\n \\"Email\\": \\"test2@aliyun.com\\"\\n }\\n ],\\n \\"FailList\\": [\\n {\\n \\"Code\\": \\"ParameterIllegall\\",\\n \\"Message\\": \\"Parameter error\\",\\n \\"Email\\": \\"test1@aliyun.com\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"failList\\": [\\n {\\n \\"code\\": \\"ParameterIllegall\\",\\n \\"email\\": \\"test1@aliyun.com\\",\\n \\"message\\": \\"Parameter error\\"\\n }\\n ],\\n \\"requestId\\": \\"B862F011-5E61-4302-88BD-A4EAA5326140\\",\\n \\"successList\\": [\\n {\\n \\"email\\": \\"test2@aliyun.com\\"\\n }\\n ]\\n}"},{"type":"xml","example":"\\n\\n ParameterIllegall\\n test1@aliyun.com\\n Parameter error\\n\\n7A3D0E4A-0D4B-4BD0-90D7-A61DF8DD26AE\\n\\n test2@aliyun.com\\n\\n","errorExample":"\\n\\n \\n \\n test1@aliyun.com\\n Parameter error\\n ParameterIllegall\\n \\n \\n test2@aliyun.com\\n Parameter error\\n ParameterIllegall\\n \\n \\n 7A3D0E4A-0D4B-4BD0-90D7-A61DF8DD26AE\\n \\n"}]',
'title' => '删除已经验证通过的邮箱',
'description' => '> 删除后如需继续使用该邮箱,您需要重新完成邮箱验证。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'VerifyEmail' => [
'summary' => '调用VerifyEmail接口提交邮箱验证。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => [
'description' => '邮箱验证链接后的token码。'."\n"
."\n"
.'验证邮件发送成功后,您可以登录待进行验证的邮箱中查看token码。',
'type' => 'string',
'required' => true,
'example' => '0b32247496409441e9e179ea7c2e0****',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FD3AD289-83EE-4E32-803A-CF1B3A8EEE64',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FD3AD289-83EE-4E32-803A-CF1B3A8EEE64\\"\\n}","errorExample":"{\\n \\"requestId\\":\\"6ED795BD-192E-4921-B8E5-1BCA6F71186C\\"\\n}"},{"type":"xml","example":"\\n FD3AD289-83EE-4E32-803A-CF1B3A8EEE64\\n","errorExample":"\\n\\n FD3AD289-83EE-4E32-803A-CF1B3A8EEE64\\n"}]',
'title' => '提交邮箱验证',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResendEmailVerification' => [
'summary' => '调用ResendEmailVerification接口重新发送验证邮件。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '待重新获取验证邮件的邮箱,多个邮箱之间使用英文逗号(,)隔开。',
'type' => 'string',
'required' => true,
'example' => 'test1@aliyun.com,test2@aliyun.com',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '0EA54E99-DB48-4CE3-A099-6ED8E451B8AC',
],
'SuccessList' => [
'description' => '验证邮件发送成功列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => '验证邮箱。',
'type' => 'string',
'example' => 'test2@aliyun.com',
],
'Code' => [
'description' => '返回code。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'Success',
],
],
],
],
'FailList' => [
'description' => '验证邮件发送失败列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => '验证邮箱。',
'type' => 'string',
'example' => 'test1@aliyun.com',
],
'Code' => [
'description' => '返回code。',
'type' => 'string',
'example' => 'SendTokenQuotaExceeded',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'The maximum number of attempts allowed to send the email verification link is exceeded.',
],
],
],
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0EA54E99-DB48-4CE3-A099-6ED8E451B8AC\\",\\n \\"SuccessList\\": [\\n {\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Success\\",\\n \\"Email\\": \\"test2@aliyun.com\\"\\n }\\n ],\\n \\"FailList\\": [\\n {\\n \\"Code\\": \\"SendTokenQuotaExceeded\\",\\n \\"Message\\": \\"The maximum number of attempts allowed to send the email verification link is exceeded.\\",\\n \\"Email\\": \\"test1@aliyun.com\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"failList\\": [\\n {\\n \\"code\\": \\"SendTokenQuotaExceeded\\",\\n \\"email\\": \\"test1@aliyun.com\\",\\n \\"message\\": \\"The maximum number of attempts allowed to send the email verification link is exceeded.\\"\\n },\\n {\\n \\"code\\": \\"ParameterIllegall\\",\\n \\"email\\": \\"test2@aliyun.com\\",\\n \\"message\\": \\"Parameter error\\"\\n }\\n ],\\n \\"requestId\\": \\"8D93B5EC-09D5-43C3-A5ED-AFBC6A98DDDF\\",\\n \\"successList\\": []\\n}"},{"type":"xml","example":"\\n\\n SendTokenQuotaExceeded\\n test1@aliyun.com\\n The maximum number of attempts allowed to send the email verification link is exceeded.\\n\\n\\n ParameterIllegall\\n test2@aliyun.com\\n Parameter error\\n\\n0EA54E99-DB48-4CE3-A099-6ED8E451B8AC\\n","errorExample":"\\n\\n \\n \\n test1@aliyun.com\\n The maximum number of attempts allowed to send the email verification link is exceeded.\\n SendTokenQuotaExceeded\\n \\n \\n test2@aliyun.com\\n The maximum number of attempts allowed to send the email verification link is exceeded.\\n SendTokenQuotaExceeded\\n \\n \\n 0EA54E99-DB48-4CE3-A099-6ED8E451B8AC\\n \\n"}]',
'title' => '重新发送验证邮件',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SubmitEmailVerification' => [
'summary' => '调用SubmitEmailVerification接口发送邮箱验证邮件。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '需要完成验证的邮箱,多个邮箱之间使用英文逗号(,)隔开。',
'type' => 'string',
'required' => true,
'example' => 'username@example.com',
],
],
[
'name' => 'SendIfExist',
'in' => 'query',
'schema' => [
'description' => '验证邮件已经存在时是否重新发送邮件。取值:'."\n"
."\n"
.'- **true**:重新发送验证邮件。'."\n"
.'- **false**:不重新发送验证邮件。'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为127.0.0.1。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E2A8A5EF-DF8A-4C48-8FD4-9F6BD71AB26D',
],
'ExistList' => [
'description' => '验证邮件已经存在列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => '验证邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'Code' => [
'description' => '返回code。',
'type' => 'string',
'example' => 'SendTokenQuotaExceeded',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'The maximum number of attempts allowed to send the email verification link is exceeded.',
],
],
],
],
'SuccessList' => [
'description' => '验证邮件发送成功列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => '验证邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'Code' => [
'description' => '返回code。',
'type' => 'string',
'example' => 'Success',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'Success',
],
],
],
],
'FailList' => [
'description' => '验证邮件发送失败列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => '验证邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'Code' => [
'description' => '返回code。',
'type' => 'string',
'example' => 'SendTokenQuotaExceeded',
],
'Message' => [
'description' => '返回信息。',
'type' => 'string',
'example' => 'The maximum number of attempts allowed to send the email verification link is exceeded',
],
],
],
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E2A8A5EF-DF8A-4C48-8FD4-9F6BD71AB26D\\",\\n \\"ExistList\\": [\\n {\\n \\"Email\\": \\"username@example.com\\",\\n \\"Code\\": \\"SendTokenQuotaExceeded\\",\\n \\"Message\\": \\"The maximum number of attempts allowed to send the email verification link is exceeded.\\"\\n }\\n ],\\n \\"SuccessList\\": [\\n {\\n \\"Email\\": \\"username@example.com\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"Success\\"\\n }\\n ],\\n \\"FailList\\": [\\n {\\n \\"Email\\": \\"username@example.com\\",\\n \\"Code\\": \\"SendTokenQuotaExceeded\\",\\n \\"Message\\": \\"The maximum number of attempts allowed to send the email verification link is exceeded\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"E2A8A5EF-DF8A-4C48-8FD4-9F6BD71AB26D\\n\\n username@example.com\\n The maximum number of attempts allowed to send the email verification link is exceeded.\\n SendTokenQuotaExceeded\\n\\n\\n username@example.com\\n Success\\n Success\\n\\n\\n username@example.com\\n The maximum number of attempts allowed to send the email verification link is exceeded\\n SendTokenQuotaExceeded\\n","errorExample":"\\n\\n \\n \\n aaa@test.com\\n The maximum number of attempts allowed to send the email\\n verification link is exceeded.\\n \\n SendTokenQuotaExceeded\\n \\n \\n E2A8A5EF-DF8A-4C48-8FD4-9F6BD71AB26D\\n \\n \\n \\n ccc@test.com\\n \\n \\n \\n \\n ddd@test.com\\n \\n \\n \\n \\n"}]',
'title' => '发送邮箱验证邮件',
'description' => '收到验证邮件后您需要在3天内登录邮箱完成验证。如果验证邮件已过期,您可以调用[ResendEmailVerification](~~67734~~)接口重新发送验证邮件。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryEmailVerification' => [
'summary' => '调用QueryEmailVerification查询邮箱验证结果。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '待查询的邮箱。',
'type' => 'string',
'required' => true,
'example' => 'abc@aliyun.com',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'VerificationStatus' => [
'description' => '邮箱验证状态。取值:'."\n"
.'- **0**:等待验证。'."\n"
.'- **1**:验证成功。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'GmtCreate' => [
'description' => '数据库记录的邮箱创建时间。',
'type' => 'string',
'example' => '2019-02-19 16:38:07',
],
'Email' => [
'description' => '查询到的邮箱。',
'type' => 'string',
'example' => 'abc@aliyun.com',
],
'EmailVerificationNo' => [
'description' => '邮箱验证编号(默认为系统自动生成的流水号)。',
'type' => 'string',
'example' => '72b36ba0572e423bbb3f19640896****',
],
'ConfirmIp' => [
'description' => '完成邮箱验证的电脑IP地址。',
'type' => 'string',
'example' => '42.*.*.31',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'FC4F7D02-8A83-4E37-B935-2D48A1B8423E',
],
'UserId' => [
'description' => '用户ID。',
'type' => 'string',
'example' => '140692647406****',
],
'GmtModified' => [
'description' => '数据库记录的邮箱更新时间。',
'type' => 'string',
'example' => '2019-02-19 16:40:38',
],
'SendIp' => [
'description' => '用户发起邮件验证的IP地址。',
'type' => 'string',
'example' => '42.*.*.115',
],
'VerificationTime' => [
'description' => '完成邮箱验证的具体时间。',
'type' => 'string',
'example' => '2019-02-19 16:40:38',
],
'TokenSendTime' => [
'description' => '邮箱验证Token的发送时间。',
'type' => 'string',
'example' => '2019-02-19 16:38:07',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"VerificationStatus\\": 1,\\n \\"GmtCreate\\": \\"2019-02-19 16:38:07\\",\\n \\"Email\\": \\"abc@aliyun.com\\",\\n \\"EmailVerificationNo\\": \\"72b36ba0572e423bbb3f19640896****\\",\\n \\"ConfirmIp\\": \\"42.*.*.31\\",\\n \\"RequestId\\": \\"FC4F7D02-8A83-4E37-B935-2D48A1B8423E\\",\\n \\"UserId\\": \\"140692647406****\\",\\n \\"GmtModified\\": \\"2019-02-19 16:40:38\\",\\n \\"SendIp\\": \\"42.*.*.115\\",\\n \\"VerificationTime\\": \\"2019-02-19 16:40:38\\",\\n \\"TokenSendTime\\": \\"2019-02-19 16:38:07\\"\\n}","errorExample":""},{"type":"xml","example":"\\n42.*.*.31\\n2019-02-19 16:38:07\\nabc@aliyun.com\\nFC4F7D02-8A83-4E37-B935-2D48A1B8423E\\n1\\n42.*.*.115\\n2019-02-19 16:40:38\\n72b36ba0572e423bbb3f19640896****\\n140692647406****\\n2019-02-19 16:38:07\\n2019-02-19 16:40:38\\n","errorExample":""}]',
'title' => '查询邮箱验证结果',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListEmailVerification' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'BeginCreateTime',
'in' => 'query',
'schema' => [
'description' => '查询创建邮箱验证的开始时间,计算方式为UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndCreateTime',
'in' => 'query',
'schema' => [
'description' => '查询创建邮箱验证的结束时间,计算方式为UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '待查询的邮箱地址,每次仅可上传一个邮箱。',
'type' => 'string',
'required' => false,
'example' => 'username@example.com',
],
],
[
'name' => 'VerificationStatus',
'in' => 'query',
'schema' => [
'description' => '邮箱验证状态。取值:'."\n"
.'- **0**:等待验证。'."\n"
.'- **1**:验证成功。'."\n"
.' ',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '域名列表分页的页码,默认值为**1**,可根据自身需求进行设置。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '域名列表分页的大小,默认值为**500**,最大值为**5000**,可根据自身需求设置。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '500',
'default' => '500',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。',
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '78C60CC3-FF0A-44E2-989A-DDE0597791C3',
],
'PageSize' => [
'description' => '分页的大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '500',
],
'TotalPageNum' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Data' => [
'description' => '邮箱验证列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VerificationTime' => [
'description' => '完成邮箱验证的具体时间。',
'type' => 'string',
'example' => '2017-12-25 03:41:11',
],
'Email' => [
'description' => '进行验证的邮箱地址。',
'type' => 'string',
'example' => 'username@example.com',
],
'EmailVerificationNo' => [
'description' => '邮箱验证编号(默认为系统自动生成的流水号)。',
'type' => 'string',
'example' => '00000a21fd374da99d9c95b48500000',
],
'UserId' => [
'description' => '用户ID。',
'type' => 'string',
'example' => '0000',
],
'GmtCreate' => [
'description' => '数据库记录的创建时间。',
'type' => 'string',
'example' => '2017-12-25 03:38:46',
],
'VerificationStatus' => [
'description' => '邮箱验证状态,取值:'."\n"
.'- **0**:等待验证。'."\n"
.'- **1**:验证成功。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TokenSendTime' => [
'description' => '邮箱验证Token的发送时间。',
'type' => 'string',
'example' => '2017-12-25 03:38:46',
],
'SendIp' => [
'description' => '用户发起邮件验证的IP地址。',
'type' => 'string',
'example' => '127.0.0.1',
],
'GmtModified' => [
'description' => '数据库记录的更新时间。',
'type' => 'string',
'example' => '2017-12-25 03:41:11',
],
'ConfirmIp' => [
'description' => '完成邮箱验证的电脑IP地址。',
'type' => 'string',
'example' => '127.0.0.1',
],
],
],
],
'TotalItemNum' => [
'description' => '域名总记录数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 1,\\n \\"RequestId\\": \\"78C60CC3-FF0A-44E2-989A-DDE0597791C3\\",\\n \\"PageSize\\": 500,\\n \\"TotalPageNum\\": 1,\\n \\"Data\\": [\\n {\\n \\"VerificationTime\\": \\"2017-12-25 03:41:11\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"EmailVerificationNo\\": \\"00000a21fd374da99d9c95b48500000\\",\\n \\"UserId\\": \\"0000\\",\\n \\"GmtCreate\\": \\"2017-12-25 03:38:46\\",\\n \\"VerificationStatus\\": 1,\\n \\"TokenSendTime\\": \\"2017-12-25 03:38:46\\",\\n \\"SendIp\\": \\"127.0.0.1\\",\\n \\"GmtModified\\": \\"2017-12-25 03:41:11\\",\\n \\"ConfirmIp\\": \\"127.0.0.1\\"\\n }\\n ],\\n \\"TotalItemNum\\": 2,\\n \\"NextPage\\": false\\n}","errorExample":"{\\n \\"currentPageNum\\": 1,\\n \\"data\\": [\\n {\\n \\"confirmIp\\": \\"127.0.0.1\\",\\n \\"email\\": \\"test1@aliyun.com\\",\\n \\"emailVerificationNo\\": \\"00000a21fd374da99d9c95b48500000\\",\\n \\"gmtCreate\\": \\"Dec 25,2017 03:38:46\\",\\n \\"gmtModified\\": \\"Dec 25,2017 03:41:11\\",\\n \\"sendIp\\": \\"127.0.0.1\\",\\n \\"tokenSendTime\\": \\"Dec 25,2017 03:38:46\\",\\n \\"userId\\": \\"0000\\",\\n \\"verificationStatus\\": 1,\\n \\"verificationTime\\": \\"Dec 25,2017 03:41:11\\"\\n },\\n {\\n \\"confirmIp\\": \\"127.0.0.1\\",\\n \\"email\\": \\"test2@aliyun.com\\",\\n \\"emailVerificationNo\\": \\"0000021fd374da99d9c95b48500000\\",\\n \\"gmtCreate\\": \\"Dec 25,2017 03:32:40\\",\\n \\"gmtModified\\": \\"Dec 25,2017 03:36:57\\",\\n \\"sendIp\\": \\"127.0.0.1\\",\\n \\"tokenSendTime\\": \\"Dec 25,2017 03:35:22\\",\\n \\"userId\\": \\"0000\\",\\n \\"verificationStatus\\": 1,\\n \\"verificationTime\\": \\"Dec 25,2017 03:36:57\\"\\n }\\n ],\\n \\"nextPage\\": false,\\n \\"pageSize\\": 500,\\n \\"prePage\\": false,\\n \\"requestId\\": \\"09D3DA75-B3B5-480B-9100-92DC43919B46\\",\\n \\"totalItemNum\\": 2,\\n \\"totalPageNum\\": 1\\n}"},{"type":"xml","example":"\\n \\n \\n 127.0.0.1\\n Dec 25,2017 03:38:46\\n username@example.com\\n 1\\n 127.0.0.1\\n Dec 25,2017 03:41:11\\n 00000a21fd374da99d9c95b48500000\\n 0000\\n Dec 25,2017 03:38:46\\n Dec 25,2017 03:41:11\\n \\n \\n 2\\n 500\\n 1\\n 4BF41EC0-C147-4F88-8B3D-D569AF5C3E8B\\n false\\n 1\\n false\\n","errorExample":"\\n\\n \\n \\n 127.0.0.1\\n Dec 25,2017 03:38:46\\n test1@aliyun.com\\n 1\\n 127.0.0.1\\n Dec 25,2017 03:41:11\\n 00000a21fd374da99d9c95b48500000\\n 0000\\n Dec 25,2017 03:38:46\\n Dec 25,2017 03:41:11\\n \\n \\n 127.0.0.1\\n Dec 25,2017 03:35:22\\n test2@aliyun.com\\n 1\\n 127.0.0.1\\n Dec 25,2017 03:36:57\\n 0000021fd374da99d9c95b48500000\\n 0000\\n Dec 25,2017 03:32:40\\n Dec 25,2017 03:36:57\\n \\n \\n 2\\n 500\\n 1\\n 4BF41EC0-C147-4F88-8B3D-D569AF5C3E8B\\n false\\n 1\\n false\\n"}]',
'title' => '查询邮箱验证列表',
'summary' => '调用ListEmailVerification接口查询邮箱验证列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForUpdateProhibitionLock' => [
'summary' => '调用SaveSingleTaskForUpdateProhibitionLock提交禁止更新锁任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '开启关闭状态。取值:'."\n"
.'- **true**:开启;'."\n"
.'- **false**:关闭。'."\n"
.' ',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f5492a',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\",\\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\",\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\"\\n}"},{"type":"xml","example":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n","errorExample":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n"}]',
'title' => '提交禁止更新锁任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForUpdateProhibitionLock' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '开启关闭状态。取值:'."\n"
.'- **true**:开启;'."\n"
.'- **false**:关闭。'."\n"
.' ',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
'required' => true,
'example' => 'aliyundoc.com',
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f5492a',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\",\\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\",\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\"\\n}"},{"type":"xml","example":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n","errorExample":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n"}]',
'title' => '提交批量禁止更新锁任务',
'summary' => '调用SaveBatchTaskForUpdateProhibitionLock提交批量禁止更新锁任务。',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveTaskForUpdatingRegistrantInfoByRegistrantProfileID' => [
'summary' => '通过信息模板编号提交修改注册联系人信息任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '信息模板编号。您可以通过[QueryRegistrantProfiles](https://help.aliyun.com/document_detail/67701.htm?spm=a2c4g.11186623.0.0.33f420daTwRQaO)接口查询信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
[
'name' => 'TransferOutProhibited',
'in' => 'query',
'schema' => [
'description' => '是否添加禁止转出限制,表示所有者修改后是否限制域名60天转出。取值:'."\n"
.'- **false**:不添加。'."\n"
.'- **true**:添加。'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名列表,多个域名时使用**list**方式传递。域名列表可通过[QueryDomainList](https://help.aliyun.com/document_detail/69362.htm?spm=a2c4g.11186623.0.0.33f4253cSJy3m8)接口获取。',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'required' => true,
'example' => 'example.com',
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}"},{"type":"xml","example":"\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n","errorExample":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n"}]',
'title' => '提交修改注册联系人信息任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](https://help.aliyun.com/document_detail/67710.htm?spm=a2c4g.11186623.0.0.33f47edeV0nkFx)接口查询。修改后注册联系人信息和模板信息一致,如果域名是强制实名认证域名,修改成功后域名会变为实名认证成功状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveTaskForUpdatingRegistrantInfoByIdentityCredential' => [
'summary' => '调用SaveTaskForUpdatingRegistrantInfoByIdentityCredential提交批量通过联系人信息和资料修改注册联系人信息任务,同时要求必须填写相应资料。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PostalCode',
'in' => 'query',
'schema' => [
'description' => '邮政编码。',
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'description' => '具体的地址。',
'type' => 'string',
'required' => false,
'example' => 'chao yang qu',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'City',
'in' => 'query',
'schema' => [
'description' => '城市。',
'type' => 'string',
'required' => false,
'example' => 'bei jing shi',
],
],
[
'name' => 'RegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '持有者名称。',
'type' => 'string',
'required' => false,
'example' => 'ce shi',
],
],
[
'name' => 'RegistrantName',
'in' => 'query',
'schema' => [
'description' => '联系人名称。',
'type' => 'string',
'required' => false,
'example' => 'ce shi',
],
],
[
'name' => 'Province',
'in' => 'query',
'schema' => [
'description' => '省份。',
'type' => 'string',
'required' => false,
'example' => 'bei jing',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '邮箱。',
'type' => 'string',
'required' => false,
'example' => 'test@aliyun.com',
],
],
[
'name' => 'Country',
'in' => 'query',
'schema' => [
'description' => '国家代码,如**CN**、**US**。',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
],
[
'name' => 'TelArea',
'in' => 'query',
'schema' => [
'description' => '电话国家代码。',
'type' => 'string',
'required' => true,
'example' => '86',
],
],
[
'name' => 'Telephone',
'in' => 'query',
'schema' => [
'description' => '电话号码。',
'type' => 'string',
'required' => true,
'example' => '12345678',
],
],
[
'name' => 'TelExt',
'in' => 'query',
'schema' => [
'description' => '分机号码。',
'type' => 'string',
'required' => false,
'example' => '12345',
],
],
[
'name' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '中文城市。',
'type' => 'string',
'required' => false,
'example' => '北京市',
],
],
[
'name' => 'ZhRegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '中文持有者名称。',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'ZhRegistrantName',
'in' => 'query',
'schema' => [
'description' => '中文联系人名称。',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'ZhProvince',
'in' => 'query',
'schema' => [
'description' => '中文省份。',
'type' => 'string',
'required' => false,
'example' => '北京',
],
],
[
'name' => 'ZhAddress',
'in' => 'query',
'schema' => [
'description' => '中文地址。',
'type' => 'string',
'required' => false,
'example' => '朝阳区',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '域名类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。',
'type' => 'string',
'required' => true,
'example' => '1',
'enum' => [
'1',
'2',
],
],
],
[
'name' => 'IdentityCredentialType',
'in' => 'query',
'schema' => [
'description' => '实名认证证件类型。取值:'."\n"
.'- **SFZ**:身份证。'."\n"
.'- **HZ**:护照。'."\n"
.'- **YYZZ**:营业执照。'."\n"
.'- **ORG**:组织机构代码证。'."\n"
.'- **XYDM**:统一社会信用代码证书。'."\n"
.'- **TXZ**:港澳居民来往内地通行证。'."\n"
."\n"
.'如果您使用的证件不在上述范围中,请参见[支持实名认证的证件类型](~~72209~~),查看相应证件类型的取值。'."\n"
."\n"
.'> 请务必选择与您传入的证件一致的证件类型。',
'type' => 'string',
'required' => true,
'example' => 'SFZ',
],
],
[
'name' => 'IdentityCredentialNo',
'in' => 'query',
'schema' => [
'description' => '实名认证资料证件号码,如:身份证号码、统一社会信用代码。',
'type' => 'string',
'required' => true,
'example' => '5****************9',
],
],
[
'name' => 'IdentityCredential',
'in' => 'formData',
'schema' => [
'description' => '使用Base64编码的实名认证资料图片。图片要求如下:'."\n"
.'- 图片为**jpg**或**bmp**格式。'."\n"
.'- 原图片大小为**55K~1M**。'."\n",
'type' => 'string',
'required' => true,
'example' => 'h6UPhXz/ADP/2Q==',
],
],
[
'name' => 'TransferOutProhibited',
'in' => 'query',
'schema' => [
'description' => '是否添加禁止转出限制,表示持有者修改后是否限制域名60天转出。默认为**false**,不限制转出。'."\n"
.' ',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'description' => '域名列表。',
'type' => 'string',
'required' => false,
'example' => 'alibabacloud.com',
],
'required' => true,
'example' => 'alibabacloud.com',
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'EDC28FEC-6BE0-4583-95BC-test',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '880f1579-be51-4dd3-a69d-test',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EDC28FEC-6BE0-4583-95BC-test\\",\\n \\"TaskNo\\": \\"880f1579-be51-4dd3-a69d-test\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"464AF466-CA8E-43A8-B61D-test\\",\\n \\"taskNo\\": \\"65de2165-ca09-491f-9fe0-test\\"\\n}"},{"type":"xml","example":"\\n\\n 880f1579-be51-4dd3-a69d-test\\n EDC28FEC-6BE0-4583-95BC-test\\n","errorExample":"\\n\\n 880f1579-be51-4dd3-a69d-test\\n EDC28FEC-6BE0-4583-95BC-test\\n"}]',
'title' => '提交批量修改注册联系人信息任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForUpdatingContactInfo' => [
'summary' => '调用SaveSingleTaskForUpdatingContactInfo提交域名信息修改任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号。',
'type' => 'string',
'required' => false,
'example' => 'S123456789',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
[
'name' => 'ContactType',
'in' => 'query',
'schema' => [
'description' => '联系人类型。取值:'."\n"
.'- **registrant**;'."\n"
.'- **admin**;'."\n"
.'- **billing**;'."\n"
.'- **tech**。'."\n"
.' ',
'type' => 'string',
'required' => true,
'example' => 'registrant',
],
],
[
'name' => 'AddTransferLock',
'in' => 'query',
'schema' => [
'description' => '是否添加禁止转出限制,此参数只对 **ContactType**=**registrant** 情况下起作用,表示持有者修改后是否限制域名60天转出。默认为**false**,不限制转出。'."\n"
.' ',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}"},{"type":"xml","example":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n","errorExample":"\\n\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n"}]',
'title' => '提交域名信息修改任务',
'description' => '任务执行结果请通过[查询任务详情列表](~~67710~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForUpdatingContactInfoByNewContact' => [
'summary' => '通过新联系人信息,提交域名信息修改任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'description' => '具体的地址。',
'type' => 'string',
'required' => false,
'example' => 'chao yang qu',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'City',
'in' => 'query',
'schema' => [
'description' => '城市。',
'type' => 'string',
'required' => false,
'example' => 'bei jing shi',
],
],
[
'name' => 'RegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '持有者名称。',
'type' => 'string',
'required' => false,
'example' => 'ce shi',
],
],
[
'name' => 'RegistrantName',
'in' => 'query',
'schema' => [
'description' => '联系人名称。',
'type' => 'string',
'required' => false,
'example' => 'ce shi',
],
],
[
'name' => 'Province',
'in' => 'query',
'schema' => [
'description' => '省份。',
'type' => 'string',
'required' => false,
'example' => 'bei jing',
],
],
[
'name' => 'Country',
'in' => 'query',
'schema' => [
'description' => '国家代码,如**CN**,**US**。',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '邮箱。',
'type' => 'string',
'required' => false,
'example' => 'test@aliyun.com',
],
],
[
'name' => 'PostalCode',
'in' => 'query',
'schema' => [
'description' => '邮政编码。',
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'TelArea',
'in' => 'query',
'schema' => [
'description' => '电话国家代码。',
'type' => 'string',
'required' => false,
'example' => '86',
],
],
[
'name' => 'Telephone',
'in' => 'query',
'schema' => [
'description' => '电话号码。',
'type' => 'string',
'required' => false,
'example' => '1234567890',
],
],
[
'name' => 'TelExt',
'in' => 'query',
'schema' => [
'description' => '分机号码。',
'type' => 'string',
'required' => false,
'example' => '1235',
],
],
[
'name' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '中文城市。',
'type' => 'string',
'required' => false,
'example' => '北京市',
],
],
[
'name' => 'ZhRegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '中文持有者名称。'."\n",
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'ZhRegistrantName',
'in' => 'query',
'schema' => [
'description' => '中文联系人名称。',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'ZhProvince',
'in' => 'query',
'schema' => [
'description' => '中文省份。',
'type' => 'string',
'required' => false,
'example' => '北京',
],
],
[
'name' => 'ZhAddress',
'in' => 'query',
'schema' => [
'description' => '中文地址。',
'type' => 'string',
'required' => false,
'example' => '朝阳区',
],
],
[
'name' => 'ContactType',
'in' => 'query',
'schema' => [
'description' => '联系人类型。取值:'."\n"
.'- **registrant**:域名持有者。'."\n"
.'- **admin**:管理者。'."\n"
.'- **billing**:付费者。'."\n"
.'- **tech**:技术者。',
'type' => 'string',
'required' => true,
'example' => 'registrant',
'enum' => [
'registrant',
'admin',
'billing',
'tech',
],
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '域名类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。'."\n"
.' ',
'type' => 'string',
'required' => true,
'example' => '1',
'enum' => [
'1',
'2',
],
],
],
[
'name' => 'TransferOutProhibited',
'in' => 'query',
'schema' => [
'description' => '是否添加禁止转出限制,此参数只对**ContactType**=**registrant**情况下起作用,表示持有者修改后是否限制域名60天转出。默认为**false**,不限制转出。'."\n"
.' ',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'string',
'required' => false,
'example' => 'alibabacloud.com',
],
'required' => true,
'example' => 'alibabacloud.com',
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '464AF466-CA8E-43A8-B61D-test',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '65de2165-ca09-491f-9fe0-test',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"464AF466-CA8E-43A8-B61D-test\\",\\n \\"TaskNo\\": \\"65de2165-ca09-491f-9fe0-test\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"464AF466-CA8E-43A8-B61D-test\\",\\n \\"taskNo\\": \\"65de2165-ca09-491f-9fe0-test\\"\\n}"},{"type":"xml","example":"\\n464AF466-CA8E-43A8-B61D-test\\n65de2165-ca09-491f-9fe0-test\\n","errorExample":"\\n\\n 880f1579-be51-4dd3-a69d-test\\n EDC28FEC-6BE0-4583-95BC-test\\n"}]',
'title' => '提交域名信息修改任务',
'description' => '任务执行结果请通过[查询任务详情列表](~~67710~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForUpdatingContactInfoByRegistrantProfileId' => [
'summary' => '调用SaveBatchTaskForUpdatingContactInfoByRegistrantProfileId提交批量域名信息修改任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '信息模板编号。'."\n"
.'信息模板创建成功后由系统自动生成,您可以调用[QueryRegistrantProfiles](~~67701~~)接口查询信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1',
],
],
[
'name' => 'ContactType',
'in' => 'query',
'schema' => [
'description' => '需要修改的联系人类型。取值:'."\n"
.'- **registrant**:域名持有者。'."\n"
.'- **admin**:管理者。'."\n"
.'- **billing**:付费者。'."\n"
.'- **tech**:技术者。'."\n"
.' ',
'type' => 'string',
'required' => true,
'example' => 'registrant',
'enum' => [
'registrant',
'admin',
'billing',
'tech',
],
],
],
[
'name' => 'TransferOutProhibited',
'in' => 'query',
'schema' => [
'description' => '是否添加禁止转出限制,此参数只在**ContactType**的参数值为**registrant**的情况下有效,表示持有者修改后是否限制域名60天转出。取值:'."\n"
.'- **false**:不转出。'."\n"
.'- **true**:转出。'."\n"
."\n"
.'默认值为**false**。 ',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名。如需传入多个域名,请使用**list**方式传入。',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
'required' => true,
'example' => 'example.com',
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'EDC28FEC-6BE0-4583-95BC',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '880f1579-be51-4dd3-a69d',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EDC28FEC-6BE0-4583-95BC\\",\\n \\"TaskNo\\": \\"880f1579-be51-4dd3-a69d\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"464AF466-CA8E-43A8-B61D-test\\",\\n \\"taskNo\\": \\"65de2165-ca09-491f-9fe0-test\\"\\n}"},{"type":"xml","example":"\\n\\n 880f1579-be51-4dd3-a69d-test\\n EDC28FEC-6BE0-4583-95BC-test\\n","errorExample":"\\n\\n 880f1579-be51-4dd3-a69d-test\\n EDC28FEC-6BE0-4583-95BC-test\\n"}]',
'title' => '提交批量域名信息修改任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForCreatingOrderTransfer' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'CouponNo',
'in' => 'query',
'schema' => [
'description' => '代金券编号。',
'type' => 'string',
'required' => false,
'example' => '123123',
],
],
[
'name' => 'UseCoupon',
'in' => 'query',
'schema' => [
'description' => '是否使用代金券。取值:'."\n"
."\n"
.'- **false**:不使用。'."\n"
.'- **true**:使用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '优惠券编号。',
'type' => 'string',
'required' => false,
'example' => '123123',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '是否使用优惠券。取值:'."\n"
."\n"
.'- **false**:不使用。'."\n"
.'- **true**:使用。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'OrderTransferParam',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '任务详情列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PermitPremiumTransfer' => [
'description' => '是否允许溢价词域名转入,取值'."\n"
.'- **false**:允许。'."\n"
.'- **true**:不允许。'."\n"
."\n"
.'默认值为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'RegistrantProfileId' => [
'description' => '已经实名认证的域名信息模板ID,可通过[QueryRegistrantProfileRealNameVerificationInfo](https://help.aliyun.com/document_detail/69359.htm?spm=a2c4g.11186623.0.0.5096253c12PfdB)接口获取。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456',
],
'AuthorizationCode' => [
'description' => '域名转入密码。如果涉及多个域名时使用**list**传入。',
'type' => 'string',
'required' => false,
'example' => 'testCode',
],
'DomainName' => [
'description' => '域名,如果涉及多个域名时该项传入域名列表。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n","errorExample":""}]',
'title' => '提交批量域名转入任务',
'summary' => '调用SaveBatchTaskForCreatingOrderTransfer提交批量域名转入任务。',
'description' => '任务执行结果请通过查询任务详情[QueryTaskDetailList](https://help.aliyun.com/document_detail/67710.htm?spm=a2c4g.11186623.0.0.5096389cgV6sng)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForCreatingOrderTransfer' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'AuthorizationCode',
'in' => 'query',
'schema' => [
'description' => '域名转入密码。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'testCode',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '已经实名认证域名信息模板ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '123456',
],
],
[
'name' => 'PermitPremiumTransfer',
'in' => 'query',
'schema' => [
'description' => '是否允许溢价词域名转入,默认为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'CouponNo',
'in' => 'query',
'schema' => [
'description' => '代金券编号。',
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'UseCoupon',
'in' => 'query',
'schema' => [
'description' => '是否使用代金券。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '优惠券编号。',
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '是否使用优惠券。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"492D1868-1384-4219-8F8B-7EB44534A72A\\",\\n \\"TaskNo\\":\\"939b6918-be3b-4c4f-b949-93553da52dca\\"\\n}"},{"type":"xml","example":"\\n 57fbc841-c4e5-4a23-8ed6-315091d0c40e\\n 21AF4F6F-1924-408B-BF83-88FEFA9CEF2B\\n","errorExample":"\\n 57fbc841-c4e5-4a23-8ed6-315091d0c40e\\n 21AF4F6F-1924-408B-BF83-88FEFA9CEF2B\\n"}]',
'title' => '提交域名转入任务',
'summary' => '调用SaveSingleTaskForCreatingOrderTransfer提交域名转入任务。',
'description' => '任务执行结果请通过查询任务详情[QueryTaskDetailList](~~67710~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForCancelingTransferIn' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"492D1868-1384-4219-8F8B-7EB44534A72A\\",\\n \\"TaskNo\\":\\"939b6918-be3b-4c4f-b949-93553da52dca\\"\\n}"},{"type":"xml","example":"\\n 3bdbaa0e-faa2-4ad2-98f4-bcfeb0237054\\n EEB28AA7-6051-4E71-B2CC-DAAFB2DF6BCA\\ne>","errorExample":"\\n 3bdbaa0e-faa2-4ad2-98f4-bcfeb0237054\\n EEB28AA7-6051-4E71-B2CC-DAAFB2DF6BCA\\ne>"}]',
'title' => '提交取消域名转入任务',
'summary' => '调用SaveSingleTaskForCancelingTransferIn提交取消域名转入任务。',
'description' => '任务执行结果请通过查询任务详情[QueryTaskDetailList](~~67710~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForCancelingTransferOut' => [
'summary' => '调用SaveSingleTaskForCancelingTransferOut提交取消域名转出任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"492D1868-1384-4219-8F8B-7EB44534A72A\\",\\n \\"TaskNo\\":\\"939b6918-be3b-4c4f-b949-93553da52dca\\"\\n}"},{"type":"xml","example":"\\n 3bdbaa0e-faa2-4ad2-98f4-bcfeb0237054\\n EEB28AA7-6051-4E71-B2CC-DAAFB2DF6BCA\\ne>","errorExample":"\\n 3bdbaa0e-faa2-4ad2-98f4-bcfeb0237054\\n EEB28AA7-6051-4E71-B2CC-DAAFB2DF6BCA\\ne>"}]',
'title' => '提交取消域名转出任务',
'description' => '任务执行结果请通过查询任务详情[QueryTaskDetailList](~~67710~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'TransferInReenterTransferAuthorizationCode' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'TransferAuthorizationCode',
'in' => 'query',
'schema' => [
'description' => '转移密码。',
'type' => 'string',
'required' => true,
'example' => 'testCode',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"F7C42D02-2FBE-475A-85A2-872865926EDC\\"\\n}"},{"type":"xml","example":"\\n A8734DAA-56BB-4181-825E-8EE1F0C85DF4\\n","errorExample":"\\n A8734DAA-56BB-4181-825E-8EE1F0C85DF4\\n"}]',
'title' => '域名转入重新输入转移密码',
'summary' => '调用TransferInReenterTransferAuthorizationCode域名转入重新输入转移密码。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'TransferInResendMailToken' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\"\\n}","errorExample":"{ \\"RequestId\\":\\"F7C42D02-2FBE-475A-85A2-872865926EDC\\"}"},{"type":"xml","example":"\\n 3E5DAABD-DED4-4624-A776-D04303F24C9A\\n","errorExample":"\\n 3E5DAABD-DED4-4624-A776-D04303F24C9A\\n"}]',
'title' => '域名转入重新发送验证邮件',
'summary' => '调用TransferInResendMailToken域名转入重新发送验证邮件。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'TransferInRefetchWhoisEmail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"C01181CC-D03C-465F-B89F-C78B721567D0\\"\\n}"},{"type":"xml","example":"\\n 9625281F-1176-4F57-ACBB-3AEF6E407AFE\\n","errorExample":"\\n 9625281F-1176-4F57-ACBB-3AEF6E407AFE\\n"}]',
'title' => '进行域名转入邮箱验证',
'summary' => '调用TransferInRefetchWhoisEmail进行域名转入邮箱验证。',
'description' => '系统会自动获取whois中的域名持有者邮箱,如果邮箱不对或无法获取到邮箱时,将重新抓取whois邮箱。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'TransferInCheckMailToken' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Token',
'in' => 'query',
'schema' => [
'description' => '邮箱中收到的Token。',
'type' => 'string',
'required' => true,
'example' => '3bdbaa0e-faa2-4ad2-98f4-bcfeb0237054',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60',
],
'SuccessList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SuccessDomain' => [
'type' => 'array',
'items' => [
'description' => '验证成功的域名列表。',
'type' => 'string',
'example' => 'example.com',
],
],
],
],
'FailList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailDomain' => [
'type' => 'array',
'items' => [
'description' => '验证失败的域名列表。',
'type' => 'string',
'example' => 'example.com',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\",\\n \\"SuccessList\\": {\\n \\"SuccessDomain\\": [\\n \\"example.com\\"\\n ]\\n },\\n \\"FailList\\": {\\n \\"FailDomain\\": [\\n \\"example.com\\"\\n ]\\n }\\n}","errorExample":"{\\n \\"FailList\\":{\\n \\"FailDomain\\":[]\\n },\\n \\"RequestId\\":\\"3E5677B5-6F55-4518-9A55-A9CE57313C9D\\",\\n \\"SuccessList\\":{\\n \\"SuccessDomain\\":[\\"test.com\\"]\\n }\\n}"},{"type":"xml","example":"\\n \\n C99AA313-4A94-4896-915B-4D4043C063DA\\n \\n example.com\\n \\n","errorExample":"\\n \\n C99AA313-4A94-4896-915B-4D4043C063DA\\n \\n test.com\\n \\n"}]',
'title' => '域名转入验证邮件',
'summary' => '调用TransferInCheckMailToken验证域名持有者邮件Token。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForQueryingTransferAuthorizationCode' => [
'summary' => '调用SaveSingleTaskForQueryingTransferAuthorizationCode提交获取域名转移密码任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\",\\n \\"RequestId\\": \\"AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"492D1868-1384-4219-8F8B-7EB44534A72A\\",\\n \\"TaskNo\\":\\"939b6918-be3b-4c4f-b949-93553da52dca\\"\\n}"},{"type":"xml","example":"\\n 3bdbaa0e-faa2-4ad2-98f4-bcfeb0237054\\n EEB28AA7-6051-4E71-B2CC-DAAFB2DF6BCA\\n","errorExample":"\\n 3bdbaa0e-faa2-4ad2-98f4-bcfeb0237054\\n EEB28AA7-6051-4E71-B2CC-DAAFB2DF6BCA\\n"}]',
'title' => '提交获取域名转移密码任务',
'description' => '任务执行结果请通过查询任务详情[QueryTaskDetailList](~~67710~~)接口来查询,转移密码由对应任务的TaskResult字段返回。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForTransferProhibitionLock' => [
'summary' => '调用SaveBatchTaskForTransferProhibitionLock提交批量禁止转移锁任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '开启关闭状态。取值:'."\n"
.'- **true**:开启;'."\n"
.'- **false**:关闭。'."\n"
.' ',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'type' => 'string',
],
'required' => true,
'example' => 'test1.com',
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f5492a',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\",\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\",\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\"\\n}"},{"type":"xml","example":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n","errorExample":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n"}]',
'title' => '提交批量禁止转移锁任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForTransferProhibitionLock' => [
'summary' => '调用SaveSingleTaskForTransferProhibitionLock提交禁止转移锁任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '开启关闭状态。取值:'."\n"
.'- **true**:开启;'."\n"
.'- **false**:关闭 。'."\n"
.' ',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f5492a',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\",\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\"\\n}","errorExample":"{ \\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\",\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\"\\n}"},{"type":"xml","example":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n","errorExample":"\\n\\n d3babb0a-c939-4c25-8c65-c47b65f5492a\\n F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n"}]',
'title' => '提交禁止转移锁任务',
'description' => '任务执行结果请通过[查询任务详情列表](~~67710~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ConfirmTransferInEmail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户ip',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言,枚举值范围:zh 中文;en 英文。默认为en',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '邮箱',
'type' => 'string',
'required' => true,
'example' => 'test@test.com',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名列表',
'type' => 'array',
'items' => [
'description' => '域名',
'type' => 'string',
'required' => false,
'example' => 'abc.com',
],
'required' => true,
'example' => 'abc.com',
'maxItems' => 13,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'SuccessList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SuccessDomain' => [
'description' => '成功的域名列表。',
'type' => 'array',
'items' => [
'description' => '成功域名',
'type' => 'string',
'example' => 'test.com',
],
],
],
],
'FailList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'FailDomain' => [
'description' => '失败的域名列表。',
'type' => 'array',
'items' => [
'description' => '失败域名',
'type' => 'string',
'example' => 'test.com',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\",\\n \\"SuccessList\\": {\\n \\"SuccessDomain\\": [\\n \\"test.com\\"\\n ]\\n },\\n \\"FailList\\": {\\n \\"FailDomain\\": [\\n \\"test.com\\"\\n ]\\n }\\n}","errorExample":"{\\n \\"Code\\": \\"MissingEmail\\",\\n \\"HostId\\": \\"domain.aliyuncs.com\\",\\n \\"Message\\": \\"Email is mandatory for this action.\\",\\n \\"Recommend\\": \\"https://error-center.aliyun.com/status/search?Keyword=MissingEmail&source=PopGw\\",\\n \\"RequestId\\": \\"3576F26F-C0F6-46BF-952D-990730D04BCD\\"\\n}"},{"type":"xml","example":"\\n\\n \\n test.com\\n test.net\\n \\n 44969CBD-9B1B-437B-B75B-3D125E2B96A3\\n \\n","errorExample":"\\n\\n 5BB450C6-BFFE-425F-B853-B5817ABBAE32\\n domain.aliyuncs.com\\n MissingEmail\\n Email is mandatory for this action.\\n \\n \\n \\n"}]',
'title' => '确认转入邮箱',
'summary' => '调用ConfirmTransferInEmail确认转入邮箱。',
'description' => '直接确认转入邮箱',
],
'QueryTransferInByInstanceId' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例编号。',
'type' => 'string',
'required' => true,
'example' => 'S20181T0WLI85212',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '详细域名转入状态。取值:'."\n"
.'- **10**:初始状态;'."\n"
.'- **11**:已发送邮件验证token链接;'."\n"
.'- **19**:token链接已验证成功;'."\n"
.'- **20**:已提交命名审核;'."\n"
.'- **21**:命名审核失败;'."\n"
.'- **29**:命名审核成功;'."\n"
.'- **31**:转移密码错误;'."\n"
.'- **39**:转入提交成功;'."\n"
.'- **50**:客户取消转入;'."\n"
.'- **51**:转入失败;'."\n"
.'- **52**:转入过期;'."\n"
.'- **59**:转入成功。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'TransferAuthorizationCodeSubmissionDate' => [
'description' => '转移密码提交成功时间。',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'Email' => [
'description' => '域名转入确认邮件发送邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'ProgressBarType' => [
'description' => '转移过程进度条类型。取值:'."\n"
.'- **0**:同时需要邮箱验证和命名审核;'."\n"
.'- **1**:需要邮箱验证不需要命名审核;'."\n"
.'- **2**:需要命名审核不需要邮箱验证;'."\n"
.'- **3**:不需要邮箱验证不需要命名审核。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60',
],
'InstanceId' => [
'description' => '实例编号。',
'type' => 'string',
'example' => 'S20181T0WLI85212',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'SubmissionDateLong' => [
'description' => '转移请求提交时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'SubmissionDate' => [
'description' => '转移请求提交时间。',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'SimpleTransferInStatus' => [
'description' => '转移状态。取值:'."\n"
.'- **INIT**:提交转入;'."\n"
.'- **AUTHORIZATION**:授权转入(邮箱验证);'."\n"
.'- **NAME_VERIFICATION**:命名审核;'."\n"
.'- **PASSWORD_VERIFICATION**:转移密码验证;'."\n"
.'- **PENDING**:转入处理中;'."\n"
.'- **SUCCESS**:转入成功;'."\n"
.'- **FAIL**:转入失败。',
'type' => 'string',
'example' => 'SUCCESS',
],
'TransferAuthorizationCodeSubmissionDateLong' => [
'description' => '转移密码提交成功时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'ExpirationDateLong' => [
'description' => '转入过期时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'ExpirationDate' => [
'description' => '域名转入过期时间。',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'NeedMailCheck' => [
'description' => '是否需要邮件验证。',
'type' => 'boolean',
'example' => 'true',
],
'UserId' => [
'description' => '用户编号。',
'type' => 'string',
'example' => '123456',
],
'ModificationDate' => [
'description' => '转入信息更新时间。',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'ResultDateLong' => [
'description' => '转移成功或失败的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'ResultMsg' => [
'description' => '转移失败时失败原因描述。',
'type' => 'string',
'example' => '您取消了此次域名转入',
],
'WhoisMailStatus' => [
'description' => '是否通过whois抓取到域名持有者邮箱。当域名转入处于授权转入(邮箱验证)并且该字段为**false**时,表示未通过whois抓取到域名持有者邮箱,需要等待人工处理。',
'type' => 'boolean',
'example' => 'true',
],
'ModificationDateLong' => [
'description' => '转入信息更新时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'ResultCode' => [
'description' => '转移失败时失败原因code。取值:'."\n"
.'- **clientCancelled**:您取消了此次域名转入;'."\n"
.'- **clientRejected**:域名原注册商拒绝了本次域名转入(或您通过原注册商进行了拒绝操作);'."\n"
.'- **serverCancelled**:注册局取消转入;'."\n"
.'- **transferProhibited**:域名为禁止转移状态;'."\n"
.'- **transferExpired**:您未在有效期内完成相关转入确认;'."\n"
.'- **nameVerificationFailed**:域名命名审核未通过;'."\n"
.'- **transferSubmitted**:其他用户已经提交域名转入。',
'type' => 'string',
'example' => 'clientCancelled',
],
'ResultDate' => [
'description' => '转移成功或失败的时间。',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": 11,\\n \\"TransferAuthorizationCodeSubmissionDate\\": \\"2018-03-28 00:41:42\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"ProgressBarType\\": 0,\\n \\"RequestId\\": \\"AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\",\\n \\"InstanceId\\": \\"S20181T0WLI85212\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"SubmissionDateLong\\": 1514428524669,\\n \\"SubmissionDate\\": \\"2018-03-28 00:41:42\\",\\n \\"SimpleTransferInStatus\\": \\"SUCCESS\\",\\n \\"TransferAuthorizationCodeSubmissionDateLong\\": 1514428524669,\\n \\"ExpirationDateLong\\": 1514428524669,\\n \\"ExpirationDate\\": \\"2018-03-28 00:41:42\\",\\n \\"NeedMailCheck\\": true,\\n \\"UserId\\": \\"123456\\",\\n \\"ModificationDate\\": \\"2018-03-28 00:41:42\\",\\n \\"ResultDateLong\\": 1514428524669,\\n \\"ResultMsg\\": \\"您取消了此次域名转入\\",\\n \\"WhoisMailStatus\\": true,\\n \\"ModificationDateLong\\": 1514428524669,\\n \\"ResultCode\\": \\"clientCancelled\\",\\n \\"ResultDate\\": \\"2018-03-28 00:41:42\\"\\n}","errorExample":""},{"type":"xml","example":"2018-03-28 00:41:42\\n11\\nusername@example.com\\n0\\nAF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\nexample.com\\nS20181T0WLI85212\\n1514428524669\\n2018-03-28 00:41:42\\nSUCCESS\\n1514428524669\\n1514428524669\\n2018-03-28 00:41:42\\ntrue\\n123456\\n2018-03-28 00:41:42\\n1514428524669\\ntrue\\n您取消了此次域名转入\\n1514428524669\\nclientCancelled\\n2018-03-28 00:41:42","errorExample":"\\n S20182F0RED000000\\n true\\n 123456\\n 2018-03-28 09:54:39\\n 2018-04-12 09:51:53\\n true\\n 50\\n \\n FAIL\\n You have canceled this domain name transfer in.\\n 0D6108ED-7BB3-4898-83D0-44883DE0D3E7\\n 2018-03-28 09:54:39\\n clientCancelled\\n test.com\\n 0\\n 2018-03-28 09:51:53\\n"}]',
'title' => '根据实例编号查询域名转入信息',
'summary' => '调用QueryTransferInByInstanceId根据实例编号查询域名转入信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTransferInList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'SubmissionStartDate',
'in' => 'query',
'schema' => [
'description' => '提交域名列表转入的开始时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1514428524669',
],
],
[
'name' => 'SubmissionEndDate',
'in' => 'query',
'schema' => [
'description' => '提交域名列表转入的结束时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1514428524669',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名,前缀匹配(模糊查询)。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'SimpleTransferInStatus',
'in' => 'query',
'schema' => [
'description' => '转移状态。取值:'."\n"
.'- **INIT**:提交转入。'."\n"
.'- **AUTHORIZATION**:授权转入(邮箱验证)。'."\n"
.'- **NAME_VERIFICATION**:命名审核。'."\n"
.'- **PASSWORD_VERIFICATION**:转移密码验证。'."\n"
.'- **PENDING**:转入处理中。'."\n"
.'- **SUCCESS**:转入成功。'."\n"
.'- **FAIL**:转入失败。',
'type' => 'string',
'required' => false,
'example' => 'INIT',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '域名列表的页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '域名列表分页的大小。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。',
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前域名列表的页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60',
],
'PageSize' => [
'description' => '域名列表的分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPageNum' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TransferInInfo' => [
'description' => '域名转入信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '详细域名转入状态。取值:'."\n"
.'- **10**:初始状态。'."\n"
.'- **11**:已发送邮件验证token链接。'."\n"
.'- **19**:token链接已验证成功。'."\n"
.'- **20**:已提交命名审核。'."\n"
.'- **21**:命名审核失败。'."\n"
.'- **29**:命名审核成功。'."\n"
.'- **31**:转移密码错误。'."\n"
.'- **39**:转入提交成功。'."\n"
.'- **50**:客户取消转入。'."\n"
.'- **51**:转入失败。'."\n"
.'- **52**:转入过期。'."\n"
.'- **59**:转入成功。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'UserId' => [
'description' => '用户编号。',
'type' => 'string',
'example' => '123456',
],
'ModificationDate' => [
'description' => '域名转入信息的更新时间。'."\n",
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'TransferAuthorizationCodeSubmissionDateLong' => [
'description' => '域名转移密码提交成功的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'SubmissionDateLong' => [
'description' => '域名转移请求提交的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'ResultCode' => [
'description' => '域名转移失败时的失败原因code。取值:'."\n"
.'- **clientCancelled**:您取消了此次域名转入。'."\n"
.'- **clientRejected**:域名原注册商拒绝了本次域名转入(或您通过原注册商进行了拒绝操作)。'."\n"
.'- **serverCancelled**:注册局取消转入。'."\n"
.'- **transferProhibited**:域名为禁止转移状态。'."\n"
.'- **transferExpired**:您未在有效期内完成相关转入确认。'."\n"
.'- **nameVerificationFailed**:域名命名审核未通过。'."\n"
.'- **transferSubmitted**:其他用户已经提交域名转入。',
'type' => 'string',
'example' => 'clientCancelled',
],
'NeedMailCheck' => [
'description' => '是否需要邮件验证。取值:'."\n"
."\n"
.'- **true**:需要。'."\n"
.'- **false**:不需要。',
'type' => 'boolean',
'example' => 'true',
],
'ModificationDateLong' => [
'description' => '域名转入信息更新的时间戳。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'InstanceId' => [
'description' => '实例编号。'."\n",
'type' => 'string',
'example' => 'S20181T0WLI85212',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'ProgressBarType' => [
'description' => '域名转移过程进度条类型。取值:'."\n"
.'- **0**:同时需要邮箱验证和命名审核。'."\n"
.'- **1**:需要邮箱验证不需要命名审核。'."\n"
.'- **2**:需要命名审核不需要邮箱验证。'."\n"
.'- **3**:不需要邮箱验证不需要命名审核。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ResultMsg' => [
'description' => '域名转移失败时的失败原因描述。',
'type' => 'string',
'example' => '您取消了此次域名转入',
],
'ResultDateLong' => [
'description' => '域名转移成功或失败的时间戳。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'ExpirationDate' => [
'description' => '域名转入的过期时间。',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'Email' => [
'description' => '域名转入确认邮件发送邮箱。'."\n",
'type' => 'string',
'example' => 'username@example.com',
],
'WhoisMailStatus' => [
'description' => '是否通过whois抓取到域名持有者邮箱。当域名转入处于授权转入(邮箱验证)并且该字段为**false**时,表示未通过whois抓取到域名持有者邮箱,需要等待人工处理。',
'type' => 'boolean',
'example' => 'true',
],
'TransferAuthorizationCodeSubmissionDate' => [
'description' => '域名转移密码提交成功的时间。',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'SubmissionDate' => [
'description' => '域名转移请求的提交时间。'."\n",
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'ExpirationDateLong' => [
'description' => '域名转入过期的时间戳。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'SimpleTransferInStatus' => [
'description' => '域名转移状态。取值:'."\n"
.'- **INIT**:提交转入。'."\n"
.'- **AUTHORIZATION**:授权转入(邮箱验证)。'."\n"
.'- **NAME_VERIFICATION**:命名审核。'."\n"
.'- **PASSWORD_VERIFICATION**:转移密码验证。'."\n"
.'- **PENDING**:转入处理中。'."\n"
.'- **SUCCESS**:转入成功。'."\n"
.'- **FAIL**:转入失败。',
'type' => 'string',
'example' => 'FAIL',
],
'ResultDate' => [
'description' => '域名转移成功或失败的时间。'."\n",
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
],
],
],
],
],
'TotalItemNum' => [
'description' => '总条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '40',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 1,\\n \\"RequestId\\": \\"AF7D4DCE-0776-47F2-A9B2-6FB85A87AA60\\",\\n \\"PageSize\\": 20,\\n \\"TotalPageNum\\": 2,\\n \\"Data\\": {\\n \\"TransferInInfo\\": [\\n {\\n \\"Status\\": 11,\\n \\"UserId\\": \\"123456\\",\\n \\"ModificationDate\\": \\"2018-03-28 00:41:42\\",\\n \\"TransferAuthorizationCodeSubmissionDateLong\\": 1514428524669,\\n \\"SubmissionDateLong\\": 1514428524669,\\n \\"ResultCode\\": \\"clientCancelled\\",\\n \\"NeedMailCheck\\": true,\\n \\"ModificationDateLong\\": 1514428524669,\\n \\"InstanceId\\": \\"S20181T0WLI85212\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"ProgressBarType\\": 0,\\n \\"ResultMsg\\": \\"您取消了此次域名转入\\",\\n \\"ResultDateLong\\": 1514428524669,\\n \\"ExpirationDate\\": \\"2018-03-28 00:41:42\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WhoisMailStatus\\": true,\\n \\"TransferAuthorizationCodeSubmissionDate\\": \\"2018-03-28 00:41:42\\",\\n \\"SubmissionDate\\": \\"2018-03-28 00:41:42\\",\\n \\"ExpirationDateLong\\": 1514428524669,\\n \\"SimpleTransferInStatus\\": \\"FAIL\\",\\n \\"ResultDate\\": \\"2018-03-28 00:41:42\\"\\n }\\n ]\\n },\\n \\"TotalItemNum\\": 40,\\n \\"NextPage\\": true\\n}","errorExample":"{\\n \\"CurrentPageNum\\":1,\\n \\"Data\\":{\\n \\"TransferInInfo\\":[\\n {\\n \\"DomainName\\":\\"test.com\\",\\n \\"Email\\":\\"te****st@alibaba-inc.com\\",\\n \\"ExpirationDate\\":\\"2018-04-13 15:51:01\\",\\n \\"InstanceId\\":\\"S20182G180111111\\",\\n \\"ModificationDate\\":\\"2018-03-29 15:59:02\\",\\n \\"NeedMailCheck\\":true,\\n \\"ProgressBarType\\":0,\\n \\"ResultMsg\\":\\"TransferInFailureReason.null\\",\\n \\"SimpleTransferInStatus\\":\\"PASSWORD_VERIFICATION\\",\\n \\"Status\\":31,\\n \\"SubmissionDate\\":\\"2018-03-29 15:51:01\\",\\n \\"UserId\\":\\"123456\\",\\n \\"WhoisMailStatus\\":true\\n },\\n {\\n \\"DomainName\\":\\"btest.com\\",\\n \\"Email\\":\\"b****i4@test.com\\",\\n \\"ExpirationDate\\":\\"2018-04-13 14:57:11\\",\\n \\"InstanceId\\":\\"S20182G15000000\\",\\n \\"ModificationDate\\":\\"2018-03-29 15:47:37\\",\\n \\"NeedMailCheck\\":true,\\n \\"ProgressBarType\\":0,\\n \\"ResultCode\\":\\"clientCancelled\\",\\n \\"ResultDate\\":\\"2018-03-29 15:47:37\\",\\n \\"ResultMsg\\":\\"You have canceled this domain name transfer in.\\",\\n \\"SimpleTransferInStatus\\":\\"FAIL\\",\\n \\"Status\\":50,\\n \\"SubmissionDate\\":\\"2018-03-29 14:57:11\\",\\n \\"UserId\\":\\"123456\\",\\n \\"WhoisMailStatus\\":true\\n }\\n ]\\n },\\n \\"NextPage\\":true,\\n \\"PageSize\\":2,\\n \\"PrePage\\":false,\\n \\"RequestId\\":\\"CC71762B-0A20-4D3A-AD74-C225DB8DBEAE\\",\\n \\"TotalItemNum\\":87,\\n \\"TotalPageNum\\":44\\n}"},{"type":"xml","example":"\\n \\n \\n 31\\n username@example.com\\n TransferInFailureReason.null\\n PASSWORD_VERIFICATION\\n S20182G180111111\\n 2018-03-29 16:31:02\\n example.com\\n true\\n 123456\\n 0\\n 2018-04-13 15:51:01\\n true\\n 2018-03-29 15:51:01\\n \\n \\n S20182G151111111\\n true\\n 123456\\n 2018-03-29 15:47:37\\n 2018-04-13 14:57:11\\n true\\n 50\\n username@example.com\\n FAIL\\n You have canceled this domain name transfer in.\\n 2018-03-29 15:47:37\\n clientCancelled\\n aliyundoc.com\\n 0\\n 2018-03-29 14:57:11\\n \\n \\n 87\\n 2\\n 1\\n 041FEBFE-966C-452E-A21D-38FBE520B93D\\n false\\n 44\\n true\\n","errorExample":"\\n \\n \\n 31\\n te****st@alibaba-inc.com\\n TransferInFailureReason.null\\n PASSWORD_VERIFICATION\\n S20182G180111111\\n 2018-03-29 16:31:02\\n test.com\\n true\\n 123456\\n 0\\n 2018-04-13 15:51:01\\n true\\n 2018-03-29 15:51:01\\n \\n \\n S20182G151111111\\n true\\n 123456\\n 2018-03-29 15:47:37\\n 2018-04-13 14:57:11\\n true\\n 50\\n b****i4@test.com\\n FAIL\\n You have canceled this domain name transfer in.\\n 2018-03-29 15:47:37\\n clientCancelled\\n btest.com\\n 0\\n 2018-03-29 14:57:11\\n \\n \\n 87\\n 2\\n 1\\n 041FEBFE-966C-452E-A21D-38FBE520B93D\\n false\\n 44\\n true\\n"}]',
'title' => '查询域名转入列表',
'summary' => '调用QueryTransferInList查询域名转入列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTransferOutInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '转出状态。取值:'."\n"
.'- **1**:验证手机;'."\n"
.'- **2**:验证邮箱;'."\n"
.'- **3**:已经获取转移密码;'."\n"
.'- **4**:转出处理中(收到注册局转移请求);'."\n"
.'- **5**:转出成功;'."\n"
.'- **8**:转出失败。',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
'Email' => [
'description' => '转移密码发送邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'ExpirationDate' => [
'description' => '本次获取转移密码过期时间。',
'type' => 'string',
'example' => '2018-04-13 19:57:56',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'BBEC5A50-DFDF-482E-8343-B4EB0105E055',
],
'ResultMsg' => [
'description' => '转出失败原因描述。',
'type' => 'string',
'example' => 'Transfer out rejected',
],
'PendingRequestDate' => [
'description' => '收到注册局转出请求时间。',
'type' => 'string',
'example' => '2018-04-13 19:57:56',
],
'ResultCode' => [
'description' => '转出失败原因编码。',
'type' => 'string',
'example' => 'clientRejected',
],
'TransferAuthorizationCodeSendDate' => [
'description' => '转移密码获取时间。',
'type' => 'string',
'example' => '2018-04-13 19:57:56',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": 8,\\n \\"ExpirationDate\\": \\"2018-04-13 19:57:56\\",\\n \\"PendingRequestDate\\": \\"2018-04-13 19:57:56\\",\\n \\"RequestId\\": \\"BBEC5A50-DFDF-482E-8343-B4EB0105E055\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"TransferAuthorizationCodeSendDate\\": \\"2018-04-13 19:57:56\\",\\n \\"ResultCode\\": \\"clientRejected\\",\\n \\"ResultMsg\\": \\"Transfer out rejected\\"\\n}","errorExample":""},{"type":"xml","example":"8\\nusername@example.com\\n2018-04-13 19:57:56\\nBBEC5A50-DFDF-482E-8343-B4EB0105E055\\nTransfer out rejected\\n2018-04-13 19:57:56\\nclientRejected\\n2018-04-13 19:57:56","errorExample":"\\n 3\\n 6F23B2C0-0355-4685-BB39-342956C5118B\\n 2018-03-29 19:57:56\\n 2018-04-13 19:57:56\\n"}]',
'title' => '查询域名转出信息',
'summary' => '调用QueryTransferOutInfo查询域名转出信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'CheckTransferInFeasibility' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '需要校验的域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'TransferAuthorizationCode',
'in' => 'query',
'schema' => [
'description' => '域名转入密码。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'CanTransfer' => [
'description' => '是否可以转入。取值:'."\n"
.'- **true**:可以转入。'."\n"
.'- **false**:不可以转入。',
'type' => 'boolean',
'example' => 'false',
],
'Message' => [
'description' => '不可转入时,返回错误描述。',
'type' => 'string',
'example' => 'This domain name is in transfer prohibited status, so it cannot be transferred. You can contact your original registrar to change its status.',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'FC0D6B89-2353-4D64-BD80-6606A7DBD7C1',
],
'ProductId' => [
'description' => '域名产品的编号。',
'type' => 'string',
'example' => '2a',
],
'Code' => [
'description' => '不可转入时,返回错误代码。',
'type' => 'string',
'example' => 'CheckTransferResult.DomainTransferProhibited',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"CheckTransferResult.DomainTransferProhibited\\",\\n \\"Message\\": \\"This domain name is in transfer prohibited status, so it cannot be transferred. You can contact your original registrar to change its status.\\",\\n \\"ProductId\\": \\"2a\\",\\n \\"RequestId\\": \\"FC0D6B89-2353-4D64-BD80-6606A7DBD7C1\\",\\n \\"CanTransfer\\": false\\n}","errorExample":"{\\n \\"CanTransfer\\":true,\\n \\"ProductId\\":\\"2a\\",\\n \\"RequestId\\":\\"CE82EB4C-882D-430B-A908-E0BECFC35025\\"\\n}"},{"type":"xml","example":"\\n 60D2283F-36EA-46D4-A38D-15B5A2C455E3\\n true\\n 2a\\n","errorExample":"\\n 60D2283F-36EA-46D4-A38D-15B5A2C455E3\\n true\\n 2a\\n"}]',
'title' => '校验域名是否可以转入',
'summary' => '调用CheckTransferInFeasibility校验域名是否可以转入。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForApplyQuickTransferOutOpenly' => [
'summary' => '提交快速转出域名申请任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:zh:中文; en:英文。 默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户请求IP',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'D200000-C0B9-4CD3-B92A-9B44A000000',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D200000-C0B9-4CD3-B92A-9B44A000000\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","type":"json"}]',
'title' => '提交快速转出域名申请任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口查询。',
],
'SaveBatchTaskForApplyQuickTransferOutOpenly' => [
'summary' => '提交批量快速转出域名申请任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'DomainNames',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '实例id列表',
'description' => '域名列表',
'type' => 'array',
'items' => [
'description' => '域名',
'type' => 'string',
'required' => false,
'example' => 'example.cn',
],
'required' => false,
'maxItems' => 10,
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:zh:中文; en:英文。 默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户请求ip',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'D6CB3623-4726-4947-AC2B-2C6E673B447C',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f5492a',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6CB3623-4726-4947-AC2B-2C6E673B447C\\",\\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f5492a\\"\\n}","type":"json"}]',
'title' => '提交批量快速转出域名申请任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口查询。',
],
'CancelTask' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'TaskNo',
'in' => 'query',
'schema' => [
'description' => '任务编号。'."\n"
."\n"
.'>任务编号可通过[QueryTaskList](~~67709~~)接口查询。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '7f217ae0-61f5-42e2-a1c3-42bad0124****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '010E55C9-C64C-4C85-9BB2-7C225ADA6C86',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"010E55C9-C64C-4C85-9BB2-7C225ADA6C86\\"\\n}","errorExample":""},{"type":"xml","example":"\\n200\\n\\n 010E55C9-C64C-4C85-9BB2-7C225ADA6C86\\n domain.aliyuncs.com\\n 200\\n success\\n\\nTaskCancellSuccess\\nsuccess\\nhttp://127.0.0.1/?AccessKeyId=gZzDF******6ecLAq&Action=CancelTask&Format=JSON&SignatureMethod=HMAC-SHA1&SignatureNonce=25e7f0e5b399081ea10f874e399997f9&SignatureVersion=1.0&TaskNo=43ddadb0-29bc-4183-a0a3-2bede0d8c2e5&Timestamp=2020-01-09T05%3A35%3A05Z&Version=2018-01-29&Signature=ag%2BU7yjbWdkJHC%2FNlbv5sjC6CfU%3D\\n","errorExample":""}]',
'title' => '取消进行中的任务',
'summary' => '调用CancelTask取消进行中的任务。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AcknowledgeTaskResult' => [
'summary' => '调用AcknowledgeTaskResult确认任务详情结果。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'TaskDetailNo',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '任务详情编号列表。',
'type' => 'array',
'items' => [
'description' => '任务详情编号。',
'type' => 'string',
'required' => true,
'example' => '2659c29493e94416b297a7691340ccc4',
],
'required' => true,
'example' => '2659c29493e94416b297a7691340ccc4',
'maxItems' => 13,
'minItems' => 1,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'D6CB3623-4726-4947-AC2B-2C6E673B447C',
],
'Result' => [
'description' => '确认成功数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6CB3623-4726-4947-AC2B-2C6E673B447C\\",\\n \\"Result\\": 1\\n}","errorExample":"{\\n \\"RequestId\\":\\"270F04F2-6086-4B54-A86B-A1956F231CEC\\",\\n \\"Result\\":2\\n}"},{"type":"xml","example":"\\n 2\\n 25DE4410-3E4D-493E-A5E2-927DB738CCEB\\n","errorExample":"\\n 2\\n 25DE4410-3E4D-493E-A5E2-927DB738CCEB\\n"}]',
'title' => '确认任务详情结果',
'description' => '任务详情结果确认后,将无法从[PollTaskResult](~~69361~~)接口中查询到。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTaskDetailHistory' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'TaskNo',
'in' => 'query',
'schema' => [
'description' => '任务编号。'."\n"
."\n"
.'> 任务编号可通过[QueryTaskList](~~67709~~)接口查询。',
'type' => 'string',
'required' => true,
'example' => '75addb07-28a3-450e-b5ec-test',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'DomainNameCursor',
'in' => 'query',
'schema' => [
'description' => '域名游标。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'TaskStatus',
'in' => 'query',
'schema' => [
'description' => '任务状态。取值:'."\n"
.'- **0**:等待执行。'."\n"
.'- **1**:执行中。'."\n"
.'- **2**:成功。'."\n"
.'- **3**:失败。'."\n"
.' ',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'TaskDetailNoCursor',
'in' => 'query',
'schema' => [
'description' => '任务详情游标。',
'type' => 'string',
'required' => false,
'example' => '75addb07-28a3-450e-b5ec',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '548CAE74-88F8-402F-8C12-97E747389C51',
],
'CurrentPageCursor' => [
'description' => '当前页游标。',
'type' => 'object',
'properties' => [
'UpdateTime' => [
'description' => '最近一次任务详情执行时间。',
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'TaskDetailNo' => [
'description' => '任务详情编号。',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-2342',
],
'CreateTime' => [
'description' => '任务创建时间。',
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'InstanceId' => [
'description' => '域名实例编号。'."\n",
'type' => 'string',
'example' => 'S1234456789',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息。'."\n"
.'- **CHG_DNS**:修改DNS。'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护。'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息。'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息。'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息。'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁。'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁。'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单。'."\n"
.'- **ORDER_RENEW**:创建续费订单。'."\n"
.'- **ORDER_REDEEM**:创建赎回订单。'."\n"
.'- **CREATE_DNSHOST**:创建DNS host。'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host。'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **0**:等待执行。'."\n"
.'- **1**:执行中。'."\n"
.'- **2**:执行成功。'."\n"
.'- **3**:执行失败。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**:等待执行。'."\n"
.'- **EXECUTING**:执行中。'."\n"
.'- **EXECUTE_SUCCESS**:执行成功。'."\n"
.'- **EXECUTE_FAILURE**:执行失败。',
'type' => 'string',
'example' => 'EXECUTE_SUCCESS',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '修改DNS',
],
'TryCount' => [
'description' => '任务详情重试次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ErrorMsg' => [
'description' => '任务执行结果。',
'type' => 'string',
'example' => '执行成功',
],
],
],
'Objects' => [
'description' => '任务详情信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UpdateTime' => [
'description' => '最近一次任务详情执行时间。',
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'TaskDetailNo' => [
'description' => '任务详情编号。',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-4234',
],
'CreateTime' => [
'description' => '任务创建时间。'."\n",
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'InstanceId' => [
'description' => '域名实例编号。',
'type' => 'string',
'example' => 'S123456789',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息。'."\n"
.'- **CHG_DNS**:修改DNS。'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护。'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息。'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息。'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息。'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁。'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁。'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单。'."\n"
.'- **ORDER_RENEW**:创建续费订单。'."\n"
.'- **ORDER_REDEEM**:创建赎回订单。'."\n"
.'- **CREATE_DNSHOST**:创建DNS host。'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host。'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **0**:等待执行。'."\n"
.'- **1**:执行中。'."\n"
.'- **2**:执行成功。'."\n"
.'- **3**:执行失败。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**:等待执行。'."\n"
.'- **EXECUTING**:执行中。'."\n"
.'- **EXECUTE_SUCCESS**:执行成功。'."\n"
.'- **EXECUTE_FAILURE**:执行失败。',
'type' => 'string',
'example' => 'EXECUTE_FAILURE',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '修改DNS',
],
'TryCount' => [
'description' => '任务详情重试次数。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'ErrorMsg' => [
'description' => '任务执行结果。'."\n",
'type' => 'string',
'example' => '域名有禁止更新锁',
],
],
],
],
'PrePageCursor' => [
'description' => '上一页游标。',
'type' => 'object',
'properties' => [
'UpdateTime' => [
'description' => '最近一次任务详情执行时间。',
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'TaskDetailNo' => [
'description' => '任务详情编号。',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-123',
],
'CreateTime' => [
'description' => '任务创建时间。'."\n",
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'InstanceId' => [
'description' => '域名实例编号。',
'type' => 'string',
'example' => 'S123456789',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息。'."\n"
.'- **CHG_DNS**:修改DNS。'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护。'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息。'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息。'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息。'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁。'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁。'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单。'."\n"
.'- **ORDER_RENEW**:创建续费订单。'."\n"
.'- **ORDER_REDEEM**:创建赎回订单。'."\n"
.'- **CREATE_DNSHOST**:创建DNS host。'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host。'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '任务编号。'."\n",
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **0**:等待执行。'."\n"
.'- **1**:执行中。'."\n"
.'- **2**:执行成功。'."\n"
.'- **3**:执行失败。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**:等待执行。'."\n"
.'- **EXECUTING**:执行中。'."\n"
.'- **EXECUTE_SUCCESS**:执行成功。'."\n"
.'- **EXECUTE_FAILURE**:执行失败。',
'type' => 'string',
'example' => 'EXECUTE_FAILURE',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '修改DNS',
],
'TryCount' => [
'description' => '任务详情重试次数。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'ErrorMsg' => [
'description' => '任务执行结果。',
'type' => 'string',
'example' => '域名有禁止更新锁',
],
],
],
'NextPageCursor' => [
'description' => '下一页游标。',
'type' => 'object',
'properties' => [
'UpdateTime' => [
'description' => '最近一次任务详情执行时间。',
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'TaskDetailNo' => [
'description' => '任务详情编号。',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-2424',
],
'CreateTime' => [
'description' => '任务创建时间。'."\n",
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'InstanceId' => [
'description' => '域名实例编号。',
'type' => 'string',
'example' => 'S1234567890',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息。'."\n"
.'- **CHG_DNS**:修改DNS。'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护。'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息。'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息。'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息。'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁。'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁。'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单。'."\n"
.'- **ORDER_RENEW**:创建续费订单。'."\n"
.'- **ORDER_REDEEM**:创建赎回订单。'."\n"
.'- **CREATE_DNSHOST**:创建DNS host。'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host。'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **0**:等待执行。'."\n"
.'- **1**:执行中。'."\n"
.'- **2**:执行成功。'."\n"
.'- **3**:执行失败。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**:等待执行。'."\n"
.'- **EXECUTING**:执行中。'."\n"
.'- **EXECUTE_SUCCESS**:执行成功。'."\n"
.'- **EXECUTE_FAILURE**:执行失败。',
'type' => 'string',
'example' => 'EXECUTE_FAILURE',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '修改DNS',
],
'TryCount' => [
'description' => '任务详情重试次数。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'ErrorMsg' => [
'description' => '任务执行结果。',
'type' => 'string',
'example' => '域名有禁止更新锁',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"548CAE74-88F8-402F-8C12-97E747389C51\\",\\n \\"CurrentPageCursor\\": {\\n \\"UpdateTime\\": \\"2019-07-30 00:00:00\\",\\n \\"TaskDetailNo\\": \\"75addb07-28a3-450e-b5ec-2342\\",\\n \\"CreateTime\\": \\"2019-07-30 00:00:00\\",\\n \\"InstanceId\\": \\"S1234456789\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TaskType\\": \\"CHG_DNS\\",\\n \\"TaskNo\\": \\"75addb07-28a3-450e-b5ec-test\\",\\n \\"TaskStatus\\": \\"EXECUTE_SUCCESS\\",\\n \\"TaskStatusCode\\": 2,\\n \\"TaskTypeDescription\\": \\"修改DNS\\",\\n \\"TryCount\\": 0,\\n \\"ErrorMsg\\": \\"执行成功\\"\\n },\\n \\"NextPageCursor\\": {\\n \\"UpdateTime\\": \\"2019-07-30 00:00:00\\",\\n \\"TaskDetailNo\\": \\"75addb07-28a3-450e-b5ec-2424\\",\\n \\"CreateTime\\": \\"2019-07-30 00:00:00\\",\\n \\"InstanceId\\": \\"S1234567890\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TaskType\\": \\"CHG_DNS\\",\\n \\"TaskNo\\": \\"75addb07-28a3-450e-b5ec-test\\",\\n \\"TaskStatus\\": \\"EXECUTE_FAILURE\\",\\n \\"TaskStatusCode\\": 3,\\n \\"TaskTypeDescription\\": \\"修改DNS\\",\\n \\"TryCount\\": 5,\\n \\"ErrorMsg\\": \\"域名有禁止更新锁\\"\\n },\\n \\"PrePageCursor\\": {\\n \\"UpdateTime\\": \\"2019-07-30 00:00:00\\",\\n \\"TaskDetailNo\\": \\"75addb07-28a3-450e-b5ec-123\\",\\n \\"CreateTime\\": \\"2019-07-30 00:00:00\\",\\n \\"InstanceId\\": \\"S123456789\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TaskType\\": \\"CHG_DNS\\",\\n \\"TaskNo\\": \\"75addb07-28a3-450e-b5ec-test\\",\\n \\"TaskStatus\\": \\"EXECUTE_FAILURE\\",\\n \\"TaskStatusCode\\": 3,\\n \\"TaskTypeDescription\\": \\"修改DNS\\",\\n \\"TryCount\\": 5,\\n \\"ErrorMsg\\": \\"域名有禁止更新锁\\"\\n },\\n \\"Objects\\": [\\n {\\n \\"UpdateTime\\": \\"2019-07-30 00:00:00\\",\\n \\"TaskDetailNo\\": \\"75addb07-28a3-450e-b5ec-4234\\",\\n \\"CreateTime\\": \\"2019-07-30 00:00:00\\",\\n \\"InstanceId\\": \\"S123456789\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TaskType\\": \\"CHG_DNS\\",\\n \\"TaskNo\\": \\"75addb07-28a3-450e-b5ec-test\\",\\n \\"TaskStatus\\": \\"EXECUTE_FAILURE\\",\\n \\"TaskStatusCode\\": 3,\\n \\"TaskTypeDescription\\": \\"修改DNS\\",\\n \\"TryCount\\": 5,\\n \\"ErrorMsg\\": \\"域名有禁止更新锁\\"\\n }\\n ]\\n}","errorExample":"{\\n \\"currentPageCursor\\": {},\\n \\"nextPageCursor\\": {},\\n \\"objects\\": [],\\n \\"pageSize\\": 2,\\n \\"prePageCursor\\": {},\\n \\"requestId\\": \\"CCE5DABB-48DF-403C-A7A1-A8F8B4F530CA\\"\\n}"},{"type":"xml","example":"\\n\\n\\n2\\n\\nCCE5DABB-48DF-403C-A7A1-A8F8B4F530CA\\n","errorExample":"\\n\\n 2\\n 548CAE74-88F8-402F-8C12-97E747389C51\\n"}]',
'title' => '分页查询指定域名任务的详情历史列表',
'summary' => '调用QueryTaskDetailHistory分页查询指定域名任务的详情历史列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PollTaskResult' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'TaskNo',
'in' => 'query',
'schema' => [
'description' => '任务编号。',
'type' => 'string',
'required' => false,
'example' => '75addb07-28a3-450e-b5ec-test',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号。'."\n"
."\n"
.'信息模板创建成功后由系统自动生成,您可以调用[QueryRegistrantProfiles](~~67701~~)接口查询信息模板编号。',
'type' => 'string',
'required' => false,
'example' => 'S20181T0WLI85212',
],
],
[
'name' => 'TaskResultStatus',
'in' => 'query',
'schema' => [
'description' => '任务结果类型,取值:'."\n"
.'- **2**:成功。'."\n"
.'- **3**:失败。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
'enum' => [
'2',
'3',
],
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小。最大值为**1000**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '20',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。',
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E879DC07-38EE-4408-9F33-73B30CD965CD',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPageNum' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TaskDetail' => [
'description' => '任务详情列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UpdateTime' => [
'description' => '最近一次任务详情执行时间。',
'type' => 'string',
'example' => '2018-03-26 15:22:18',
],
'TaskDetailNo' => [
'description' => '任务详情编号。',
'type' => 'string',
'example' => '15fee9d10d514bada66bd08c5723c583',
],
'CreateTime' => [
'description' => '任务创建时间。',
'type' => 'string',
'example' => '2018-03-26 15:08:20',
],
'InstanceId' => [
'description' => '域名实例编号。',
'type' => 'string',
'example' => 'S201817141000000',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '任务类型。',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'b95bc334-f7d8-4f39-8a62-4c4302a243d8',
],
'TaskResult' => [
'description' => '任务结果。',
'type' => 'string',
'example' => 'test',
],
'TaskStatusCode' => [
'description' => '任务状态码。可能值:'."\n"
.'- **0**:等待执行。'."\n"
.'- **1**:执行中。'."\n"
.'- **2**:执行成功。'."\n"
.'- **3**:执行失败。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TaskStatus' => [
'description' => '任务状态。可能值:'."\n"
.'- **WAITING_EXECUTE**:等待执行。'."\n"
.'- **EXECUTING**:执行中。'."\n"
.'- **EXECUTE_SUCCESS**:执行成功。'."\n"
.'- **EXECUTE_FAILURE**:执行失败。',
'type' => 'string',
'example' => 'EXECUTE_SUCCESS',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。如果切换了Lang参数,该字段会切换语言。',
'type' => 'string',
'example' => '修改DNS',
],
'TryCount' => [
'description' => '任务详情重试次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ErrorMsg' => [
'description' => '任务执行失败消息。',
'type' => 'string',
'example' => 'The operation is successful.',
],
],
],
],
],
],
'TotalItemNum' => [
'description' => '总条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 1,\\n \\"RequestId\\": \\"E879DC07-38EE-4408-9F33-73B30CD965CD\\",\\n \\"PageSize\\": 1,\\n \\"TotalPageNum\\": 10,\\n \\"Data\\": {\\n \\"TaskDetail\\": [\\n {\\n \\"UpdateTime\\": \\"2018-03-26 15:22:18\\",\\n \\"TaskDetailNo\\": \\"15fee9d10d514bada66bd08c5723c583\\",\\n \\"CreateTime\\": \\"2018-03-26 15:08:20\\",\\n \\"InstanceId\\": \\"S201817141000000\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TaskType\\": \\"CHG_DNS\\",\\n \\"TaskNo\\": \\"b95bc334-f7d8-4f39-8a62-4c4302a243d8\\",\\n \\"TaskResult\\": \\"test\\",\\n \\"TaskStatusCode\\": 2,\\n \\"TaskStatus\\": \\"EXECUTE_SUCCESS\\",\\n \\"TaskTypeDescription\\": \\"修改DNS\\",\\n \\"TryCount\\": 0,\\n \\"ErrorMsg\\": \\"The operation is successful.\\"\\n }\\n ]\\n },\\n \\"TotalItemNum\\": 10,\\n \\"NextPage\\": false\\n}","errorExample":"{\\n \\"CurrentPageNum\\":1,\\n \\"Data\\":{\\n \\"TaskDetail\\":[{\\n \\"CreateTime\\":\\"2018-03-26 15:08:20\\",\\n \\"DomainName\\":\\"test.com\\",\\n \\"ErrorMsg\\":\\"The operation is successful.\\",\\n \\"InstanceId\\":\\"S201817141000000\\",\\n \\"TaskDetailNo\\":\\"15fee9d10d514bada66bd08c5723c583\\",\\n \\"TaskNo\\":\\"b95bc334-f7d8-4f39-8a62-4c4302a243d8\\",\\n \\"TaskStatus\\":\\"EXECUTE_SUCCESS\\",\\n \\"TaskStatusCode\\":2,\\n \\"TaskType\\":\\"CHG_DNS\\",\\n \\"TaskTypeDescription\\":\\"DNS Modification\\",\\n \\"TryCount\\":0,\\n \\"UpdateTime\\":\\"2018-03-26 15:22:18\\"\\n }]\\n },\\n \\"PageSize\\":1,\\n \\"RequestId\\":\\"E879DC07-38EE-4408-9F33-73B30CD965CD\\",\\n \\"TotalItemNum\\":10,\\n \\"TotalPageNum\\":10\\n}"},{"type":"xml","example":"\\n \\n \\n 0\\n 15fee9d10d514bada66bd08c5723c583\\n b95bc334-f7d8-4f39-8a62-4c4302a243d8\\n 2018-03-26 15:08:20\\n S201817141000000\\n 2018-03-26 15:22:18\\n EXECUTE_SUCCESS\\n example.com\\n DNS Modification\\n 2\\n The operation is successful.\\n CHG_DNS\\n \\n \\n 10\\n 1\\n 1\\n C2CB6161-7971-4EB6-BC16-92A2BA3816D9\\n 10\\n","errorExample":"\\n \\n \\n 0\\n 15fee9d10d514bada66bd08c5723c583\\n b95bc334-f7d8-4f39-8a62-4c4302a243d8\\n 2018-03-26 15:08:20\\n S201817141000000\\n 2018-03-26 15:22:18\\n EXECUTE_SUCCESS\\n test.com\\n DNS Modification\\n 2\\n The operation is successful.\\n CHG_DNS\\n \\n \\n 10\\n 1\\n 1\\n C2CB6161-7971-4EB6-BC16-92A2BA3816D9\\n 10\\n"}]',
'title' => '获取执行完成任务详情',
'summary' => '调用PollTaskResult获取已经执行完成(包含执行成功和执行失败并超过重试次数)的域名任务详情列表。',
'description' => '该接口需要配合[AcknowledgeTaskResult](~~AcknowledgeTaskResult~~)确认任务结果。任务结果确认后,对应任务记录将无法从该接口查询到。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTaskList' => [
'summary' => '调用QueryTaskList分页查询自己账号下的域名任务列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain0NKSXL',
'FEATUREdomainBJEHHJ',
'FEATUREdomainGE2DE7',
'FEATUREdomain9WEVJX',
'FEATUREdomainDNBQWJ',
'FEATUREdomain9191Y6',
],
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'BeginCreateTime',
'in' => 'query',
'schema' => [
'description' => '查询创建日期范围的开始时间,UTC时间1970年1月1日0点距离现在的毫秒数,目前只支持按天查询。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndCreateTime',
'in' => 'query',
'schema' => [
'description' => '查询创建日期范围的结束时间,UTC时间1970年1月1日0点距离现在的毫秒数,目前只支持按天查询。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。',
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '8D7D294A-8E99-481F-B64C-017EFC793059',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalPageNum' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '22',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TaskInfo' => [
'description' => '任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息。'."\n"
.'- **CHG_DNS**:修改DNS。'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护。'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息。'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息。'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息。'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁。'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁。'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单。'."\n"
.'- **ORDER_RENEW**:创建续费订单。'."\n"
.'- **ORDER_REDEEM**:创建赎回订单。'."\n"
.'- **CREATE_DNSHOST**:创建DNS host。'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host。'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'CREATE_DNSHOST',
],
'TaskCancelStatus' => [
'description' => '任务取消状态。取值:'."\n"
.'- **INIT**:未取消。'."\n"
.'- **CANCELLING**:取消中。'."\n"
.'- **COMPLETE**:已完成。',
'type' => 'string',
'example' => 'INIT',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '8b1cd755-4928-4b02-adee-e5d41d7b1939',
],
'TaskCancelStatusCode' => [
'description' => '任务取消状态编号。取值:'."\n"
.'- **0**:未取消。'."\n"
.'- **1**:取消中。'."\n"
.'- **2**:已完成。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **1**:等待执行。'."\n"
.'- **2**:执行中。'."\n"
.'- **3**:执行完成。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**:等待执行。'."\n"
.'- **EXECUTING**:执行中。'."\n"
.'- **COMPLETE**:执行完成。',
'type' => 'string',
'example' => 'COMPLETE',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '创建DNS host',
],
'TaskNum' => [
'description' => '任务包含域名数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CreateTime' => [
'description' => '任务创建时间。',
'type' => 'string',
'example' => 'Dec 26,2017 11:00:54',
],
'Clientip' => [
'description' => '提交任务时用户IP。',
'type' => 'string',
'example' => '127.0.0.1',
],
'TaskBizType' => [
'description' => '任务业务类型。取值:'."\n"
.'- **orderWithRegistry**:注册局订单类任务。'."\n"
.'- **manageWithRegistry**:注册局管理类任务。'."\n"
.'- **manageWithNoRegistry**:非注册局管理类任务。'."\n"
.'- **batchOrderWithNoRegistry**:非注册局订单类批处理任务。',
'type' => 'string',
'example' => 'manageWithNoRegistry',
],
'TaskResult' => [
'description' => '任务结果JSON。',
'type' => 'string',
'example' => '"{\\"result\\":true}"',
],
'TaskTypeCode' => [
'description' => 'TaskType对应的code',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
'TotalItemNum' => [
'description' => '总条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '43',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 1,\\n \\"RequestId\\": \\"8D7D294A-8E99-481F-B64C-017EFC793059\\",\\n \\"PageSize\\": 2,\\n \\"TotalPageNum\\": 22,\\n \\"Data\\": {\\n \\"TaskInfo\\": [\\n {\\n \\"TaskType\\": \\"CREATE_DNSHOST\\",\\n \\"TaskCancelStatus\\": \\"INIT\\",\\n \\"TaskNo\\": \\"8b1cd755-4928-4b02-adee-e5d41d7b1939\\",\\n \\"TaskCancelStatusCode\\": 0,\\n \\"TaskStatusCode\\": 1,\\n \\"TaskStatus\\": \\"COMPLETE\\",\\n \\"TaskTypeDescription\\": \\"创建DNS host\\",\\n \\"TaskNum\\": 1,\\n \\"CreateTime\\": \\"Dec 26,2017 11:00:54\\",\\n \\"Clientip\\": \\"127.0.0.1\\",\\n \\"TaskBizType\\": \\"manageWithNoRegistry\\",\\n \\"TaskResult\\": \\"\\\\\\"{\\\\\\\\\\\\\\"result\\\\\\\\\\\\\\":true}\\\\\\"\\",\\n \\"TaskTypeCode\\": 1\\n }\\n ]\\n },\\n \\"TotalItemNum\\": 43,\\n \\"NextPage\\": true\\n}","errorExample":"{\\n \\"CurrentPageNum\\": 1,\\n \\"Data\\": {\\n \\"TaskInfo\\": [\\n {\\n \\"Clientip\\": \\"127.0.0.1\\",\\n \\"CreateTime\\": \\"Dec 26,2017 11:00:54\\",\\n \\"TaskNo\\": \\"8b1cd755-4928-4b02-adee-e5d41d7b1939\\",\\n \\"TaskNum\\": 1,\\n \\"TaskStatus\\": \\"COMPLETE\\",\\n \\"TaskType\\": \\"CREATE_DNSHOST\\"\\n },\\n {\\n \\"Clientip\\": \\"127.0.0.1\\",\\n \\"CreateTime\\": \\"Dec 26,2017 11:00:54\\",\\n \\"TaskNo\\": \\"b0069db5-db21-4e57-842a-260c370a37e2\\",\\n \\"TaskNum\\": 2,\\n \\"TaskStatus\\": \\"COMPLETE\\",\\n \\"TaskType\\": \\"CHG_DNS\\"\\n }\\n ]\\n },\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"85C735DC-872F-423B-A728-C20C2924D3C6\\",\\n \\"TotalItemNum\\": 43,\\n \\"TotalPageNum\\": 22\\n}"},{"type":"xml","example":"\\n\\n \\n \\n 127.0.0.1\\n 8b1cd755-4928-4b02-adee-e5d41d7b1939\\n Dec 26,2017 11:00:54\\n COMPLETE\\n 1\\n CREATE_DNSHOST\\n \\n \\n 127.0.0.1\\n b0069db5-db21-4e57-842a-260c370a37e2\\n Dec 26,2017 11:00:54\\n COMPLETE\\n 2\\n CHG_DNS\\n \\n \\n 43\\n 2\\n 1\\n 8D7D294A-8E99-481F-B64C-017EFC793059\\n 22\\n","errorExample":"\\n\\n \\n \\n 127.0.0.1\\n 8b1cd755-4928-4b02-adee-e5d41d7b1939\\n Dec 26,2017 11:00:54\\n COMPLETE\\n 1\\n CREATE_DNSHOST\\n \\n \\n 127.0.0.1\\n b0069db5-db21-4e57-842a-260c370a37e2\\n Dec 26,2017 11:00:54\\n COMPLETE\\n 2\\n CHG_DNS\\n \\n \\n 43\\n 2\\n 1\\n 8D7D294A-8E99-481F-B64C-017EFC793059\\n 22\\n"}]',
'title' => '分页查询自己账号下的域名任务列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTaskInfoHistory' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'BeginCreateTime',
'in' => 'query',
'schema' => [
'description' => '查询创建日期范围的开始时间,计算方式为UTC时间1970年1月1日0点距离现在的毫秒数,目前只支持按天查询。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndCreateTime',
'in' => 'query',
'schema' => [
'description' => '查询创建日期范围的结束时间,UTC时间1970年1月1日0点距离现在的毫秒数,目前只支持按天查询。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '2',
],
],
[
'name' => 'CreateTimeCursor',
'in' => 'query',
'schema' => [
'description' => '创建日期的游标(技术参数)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'TaskNoCursor',
'in' => 'query',
'schema' => [
'description' => '任务光标,翻页时传入对应页游标中的任务编号(技术参数)。',
'type' => 'string',
'required' => false,
'example' => 'aa634d3f-927e-4d17-9d2c-test',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'EB3FCCBA-CA1F-4D31-9F34-test',
],
'CurrentPageCursor' => [
'description' => '当前页的游标。',
'type' => 'object',
'properties' => [
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息;'."\n"
.'- **CHG_DNS**:修改DNS;'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护;'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息;'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息;'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息;'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁;'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁;'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单;'."\n"
.'- **ORDER_RENEW**:创建续费订单;'."\n"
.'- **ORDER_REDEEM**:创建赎回订单;'."\n"
.'- **CREATE_DNSHOST**:创建DNS host;'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host;'."\n"
.'- **UPDATE_REGISTRANT_CONTACT**:修改注册联系人;'."\n"
.'- **DELETE_DOMAIN**:删除域名;'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'aa634d3f-927e-4d17-9d2c-test',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **1**:等待执行;'."\n"
.'- **2**:执行中;'."\n"
.'- **3**:执行完成。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**;等待执行;'."\n"
.'- **EXECUTING**;执行中;'."\n"
.'- **COMPLETE**;执行完成。',
'type' => 'string',
'example' => 'COMPLETE',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '修改DNS',
],
'TaskNum' => [
'description' => '任务包含域名数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CreateTime' => [
'description' => '任务创建时间。'."\n",
'type' => 'string',
'example' => '2017-11-01 17:22:51',
],
'CreateTimeLong' => [
'description' => '任务创建时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1509528171000',
],
'Clientip' => [
'description' => '提交任务时用户IP。',
'type' => 'string',
'example' => '127.0.0.1',
],
],
],
'Objects' => [
'description' => '任务信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息;'."\n"
.'- **CHG_DNS**:修改DNS;'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护;'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息;'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息;'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息;'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁;'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁;'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单;'."\n"
.'- **ORDER_RENEW**:创建续费订单;'."\n"
.'- **ORDER_REDEEM**:创建赎回订单;'."\n"
.'- **CREATE_DNSHOST**:创建DNS host;'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host;'."\n"
.'- **UPDATE_REGISTRANT_CONTACT**:修改注册联系人;'."\n"
.'- **DELETE_DOMAIN**:删除域名;'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'aa634d3f-927e-4d17-9d2c-test',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **1**:等待执行;'."\n"
.'- **2**:执行中;'."\n"
.'- **3**:执行完成。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**;等待执行;'."\n"
.'- **EXECUTING**;执行中;'."\n"
.'- **COMPLETE**;执行完成。',
'type' => 'string',
'example' => 'COMPLETE',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '修改DNS',
],
'TaskNum' => [
'description' => '任务包含域名数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CreateTime' => [
'description' => '任务创建时间。'."\n",
'type' => 'string',
'example' => '2017-11-01 17:22:51',
],
'CreateTimeLong' => [
'description' => '任务创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1509528171000',
],
'Clientip' => [
'description' => '提交任务时用户IP。'."\n",
'type' => 'string',
'example' => '127.0.0.1',
],
],
],
],
'PrePageCursor' => [
'description' => '上一页游标。',
'type' => 'object',
'properties' => [
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息;'."\n"
.'- **CHG_DNS**:修改DNS;'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护;'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息;'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息;'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息;'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁;'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁;'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单;'."\n"
.'- **ORDER_RENEW**:创建续费订单;'."\n"
.'- **ORDER_REDEEM**:创建赎回订单;'."\n"
.'- **CREATE_DNSHOST**:创建DNS host;'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host;'."\n"
.'- **UPDATE_REGISTRANT_CONTACT**:修改注册联系人;'."\n"
.'- **DELETE_DOMAIN**:删除域名;'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'f9baa3d5-33b9-4c81-8847-test',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **1**:等待执行;'."\n"
.'- **2**:执行中;'."\n"
.'- **3**:执行完成。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**;等待执行;'."\n"
.'- **EXECUTING**;执行中;'."\n"
.'- **COMPLETE**;执行完成。',
'type' => 'string',
'example' => 'COMPLETE',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '修改DNS',
],
'TaskNum' => [
'description' => '任务包含域名数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'CreateTime' => [
'description' => '任务创建时间。',
'type' => 'string',
'example' => '2017-11-01 17:19:47',
],
'CreateTimeLong' => [
'description' => '任务创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1509527987000',
],
'Clientip' => [
'description' => '提交任务时用户IP。',
'type' => 'string',
'example' => '127.0.0.1',
],
],
],
'NextPageCursor' => [
'description' => '下一页的游标。',
'type' => 'object',
'properties' => [
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息;'."\n"
.'- **CHG_DNS**:修改DNS;'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护;'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息;'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息;'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息;'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁;'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁;'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单;'."\n"
.'- **ORDER_RENEW**:创建续费订单;'."\n"
.'- **ORDER_REDEEM**:创建赎回订单;'."\n"
.'- **CREATE_DNSHOST**:创建DNS host;'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host;'."\n"
.'- **UPDATE_REGISTRANT_CONTACT**:修改注册联系人;'."\n"
.'- **DELETE_DOMAIN**:删除域名;'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '8f112aa1-98be-48c3-82f8-test',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **1**:等待执行;'."\n"
.'- **2**:执行中;'."\n"
.'- **3**:执行完成。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**;等待执行;'."\n"
.'- **EXECUTING**;执行中;'."\n"
.'- **COMPLETE**;执行完成。',
'type' => 'string',
'example' => 'COMPLETE',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '修改DNS',
],
'TaskNum' => [
'description' => '任务包含域名数量。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'CreateTime' => [
'description' => '任务创建时间。'."\n",
'type' => 'string',
'example' => '2017-10-27 13:07:07',
],
'CreateTimeLong' => [
'description' => '任务创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1509080827000',
],
'Clientip' => [
'description' => '提交任务时用户IP。'."\n",
'type' => 'string',
'example' => '127.0.0.1',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"EB3FCCBA-CA1F-4D31-9F34-test\\",\\n \\"CurrentPageCursor\\": {\\n \\"TaskType\\": \\"CHG_DNS\\",\\n \\"TaskNo\\": \\"aa634d3f-927e-4d17-9d2c-test\\",\\n \\"TaskStatusCode\\": 3,\\n \\"TaskStatus\\": \\"COMPLETE\\",\\n \\"TaskTypeDescription\\": \\"修改DNS\\",\\n \\"TaskNum\\": 1,\\n \\"CreateTime\\": \\"2017-11-01 17:22:51\\",\\n \\"CreateTimeLong\\": 1509528171000,\\n \\"Clientip\\": \\"127.0.0.1\\"\\n },\\n \\"Objects\\": [\\n {\\n \\"TaskType\\": \\"CHG_DNS\\",\\n \\"TaskNo\\": \\"aa634d3f-927e-4d17-9d2c-test\\",\\n \\"TaskStatusCode\\": 3,\\n \\"TaskStatus\\": \\"COMPLETE\\",\\n \\"TaskTypeDescription\\": \\"修改DNS\\",\\n \\"TaskNum\\": 1,\\n \\"CreateTime\\": \\"2017-11-01 17:22:51\\",\\n \\"CreateTimeLong\\": 1509528171000,\\n \\"Clientip\\": \\"127.0.0.1\\"\\n }\\n ],\\n \\"PrePageCursor\\": {\\n \\"TaskType\\": \\"CHG_DNS\\",\\n \\"TaskNo\\": \\"f9baa3d5-33b9-4c81-8847-test\\",\\n \\"TaskStatusCode\\": 3,\\n \\"TaskStatus\\": \\"COMPLETE\\",\\n \\"TaskTypeDescription\\": \\"修改DNS\\",\\n \\"TaskNum\\": 15,\\n \\"CreateTime\\": \\"2017-11-01 17:19:47\\",\\n \\"CreateTimeLong\\": 1509527987000,\\n \\"Clientip\\": \\"127.0.0.1\\"\\n },\\n \\"NextPageCursor\\": {\\n \\"TaskType\\": \\"CHG_DNS\\",\\n \\"TaskNo\\": \\"8f112aa1-98be-48c3-82f8-test\\",\\n \\"TaskStatusCode\\": 3,\\n \\"TaskStatus\\": \\"COMPLETE\\",\\n \\"TaskTypeDescription\\": \\"修改DNS\\",\\n \\"TaskNum\\": 15,\\n \\"CreateTime\\": \\"2017-10-27 13:07:07\\",\\n \\"CreateTimeLong\\": 1509080827000,\\n \\"Clientip\\": \\"127.0.0.1\\"\\n }\\n}","errorExample":"{\\n \\"currentPageCursor\\": {\\n \\"clientip\\": \\"127.0.0.1\\",\\n \\"createTime\\": \\"2017-11-01 17:22:51\\",\\n \\"createTimeLong\\": 1509528171000,\\n \\"taskNo\\": \\"aa634d3f-927e-4d17-9d2c-test\\",\\n \\"taskNum\\": 1,\\n \\"taskStatus\\": \\"COMPLETE\\",\\n \\"taskStatusCode\\": 3,\\n \\"taskType\\": \\"CHG_DNS\\"\\n },\\n \\"nextPageCursor\\": {\\n \\"createTime\\": \\"2017-10-27 13:07:07\\",\\n \\"createTimeLong\\": 1509080827000,\\n \\"taskNo\\": \\"8f112aa1-98be-48c3-82f8-test\\"\\n },\\n \\"objects\\": [\\n {\\n \\"clientip\\": \\"127.0.0.1\\",\\n \\"createTime\\": \\"2017-11-01 17:22:51\\",\\n \\"createTimeLong\\": 1509528171000,\\n \\"taskNo\\": \\"aa634d3f-927e-4d17-9d2c-test\\",\\n \\"taskNum\\": 1,\\n \\"taskStatus\\": \\"COMPLETE\\",\\n \\"taskStatusCode\\": 3,\\n \\"taskType\\": \\"CHG_DNS\\"\\n },\\n {\\n \\"clientip\\": \\"127.0.0.1\\",\\n \\"createTime\\": \\"2017-11-01 17:19:47\\",\\n \\"createTimeLong\\": 1509527987000,\\n \\"taskNo\\": \\"f9baa3d5-33b9-4c81-8847-test\\",\\n \\"taskNum\\": 15,\\n \\"taskStatus\\": \\"COMPLETE\\",\\n \\"taskStatusCode\\": 3,\\n \\"taskType\\": \\"CHG_DNS\\"\\n }\\n ],\\n \\"pageSize\\": 2,\\n \\"prePageCursor\\": {},\\n \\"requestId\\": \\"6EB5D9B8-AD99-4423-9D02-test\\"\\n}"},{"type":"xml","example":"\\n\\n \\n \\n 127.0.0.1\\n aa634d3f-927e-4d17-9d2c-test\\n 2017-11-01 17:22:51\\n COMPLETE\\n 1\\n 3\\n CHG_DNS\\n 1509528171000\\n \\n \\n 127.0.0.1\\n f9baa3d5-33b9-4c81-8847-test\\n 2017-11-01 17:19:47\\n COMPLETE\\n 15\\n 3\\n CHG_DNS\\n 1509527987000\\n \\n \\n 2\\n \\n 8f112aa1-98be-48c3-82f8-test\\n 2017-10-27 13:07:07\\n 1509080827000\\n \\n EB3FCCBA-CA1F-4D31-9F34-test\\n \\n 127.0.0.1\\n aa634d3f-927e-4d17-9d2c-test\\n 2017-11-01 17:22:51\\n COMPLETE\\n 1\\n 3\\n CHG_DNS\\n 1509528171000\\n \\n","errorExample":"\\n\\n \\n \\n 127.0.0.1\\n aa634d3f-927e-4d17-9d2c-test\\n 2017-11-01 17:22:51\\n COMPLETE\\n 1\\n 3\\n CHG_DNS\\n 1509528171000\\n \\n \\n 127.0.0.1\\n f9baa3d5-33b9-4c81-8847-test\\n 2017-11-01 17:19:47\\n COMPLETE\\n 15\\n 3\\n CHG_DNS\\n 1509527987000\\n \\n \\n 2\\n \\n 8f112aa1-98be-48c3-82f8-test\\n 2017-10-27 13:07:07\\n 1509080827000\\n \\n EB3FCCBA-CA1F-4D31-9F34-test\\n \\n 127.0.0.1\\n aa634d3f-927e-4d17-9d2c-test\\n 2017-11-01 17:22:51\\n COMPLETE\\n 1\\n 3\\n CHG_DNS\\n 1509528171000\\n \\n"}]',
'title' => '分页查询自己账户下的域名任务历史列表',
'summary' => '调用QueryTaskInfoHistory分页查询自己账户下的域名任务历史列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTaskDetailList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'TaskStatus',
'in' => 'query',
'schema' => [
'description' => '任务状态。取值:'."\n"
.'- **0**:等待执行。'."\n"
.'- **1**:执行中。'."\n"
.'- **2**:成功。'."\n"
.'- **3**:失败。'."\n"
.' ',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'TaskNo',
'in' => 'query',
'schema' => [
'description' => '任务编号:已成功执行的任务返回的TaskNo参数值。',
'type' => 'string',
'required' => true,
'example' => '75addb07-28a3-450e-b5ec-test',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号。'."\n"
."\n"
.'> 域名实例编号可通过[QueryDomainByDomainName](~~442021~~)[QueryDomainByDomainName](~~121704~~)'."\n"
.'接口查询。',
'type' => 'string',
'required' => false,
'example' => 'S20179H1BBI9test',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.0',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '分页页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,最大值为**1000**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。',
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6A2320E4-D870-49C9-A6DC-test',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalPageNum' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TaskDetail' => [
'description' => '任务列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UpdateTime' => [
'description' => '最近一次任务详情执行时间。',
'type' => 'string',
'example' => '2018-01-25 20:47:01',
],
'TaskDetailNo' => [
'description' => '任务详情编号。',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'CreateTime' => [
'description' => '任务创建时间。',
'type' => 'string',
'example' => '2018-01-25 20:46:57',
],
'InstanceId' => [
'description' => '域名实例编号。',
'type' => 'string',
'example' => 'S20179H1BBI9test',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '任务类型。取值:'."\n"
.'- **CHG_HOLDER**:修改所有者信息。'."\n"
.'- **CHG_DNS**:修改DNS。'."\n"
.'- **SET_WHOIS_PROTECT**:设置隐私保护。'."\n"
.'- **UPDATE_ADMIN_CONTACT**:修改管理者信息。'."\n"
.'- **UPDATE_BILLING_CONTACT**:修改付费者信息。'."\n"
.'- **UPDATE_TECH_CONTACT**:修改技术者信息。'."\n"
.'- **SET_UPDATE_PROHIBITED**:设置域名安全锁。'."\n"
.'- **SET_TRANSFER_PROHIBITED**:设置域名转移锁。'."\n"
.'- **ORDER_ACTIVATE**:创建注册订单。'."\n"
.'- **ORDER_RENEW**:创建续费订单。'."\n"
.'- **ORDER_REDEEM**:创建赎回订单。'."\n"
.'- **CREATE_DNSHOST**:创建DNS host。'."\n"
.'- **UPDATE_DNSHOST**:更新DNS host。'."\n"
.'- **SYNC_DNSHOST**:同步DNS host。',
'type' => 'string',
'example' => 'ORDER_RENEW',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '60d6e201-8ee5-47ab-8fdc-test',
],
'TaskResult' => [
'description' => '任务执行结果,用于记录部分任务类型执行后的任务结果。',
'type' => 'string',
'example' => '12345',
],
'TaskStatusCode' => [
'description' => '任务状态码。取值:'."\n"
.'- **0**:等待执行。'."\n"
.'- **1**:执行中。'."\n"
.'- **2**:执行成功。'."\n"
.'- **3**:执行失败。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TaskStatus' => [
'description' => '任务状态。取值:'."\n"
.'- **WAITING_EXECUTE**:等待执行。'."\n"
.'- **EXECUTING**:执行中。'."\n"
.'- **EXECUTE_SUCCESS**:执行成功。'."\n"
.'- **EXECUTE_FAILURE**:执行失败。',
'type' => 'string',
'example' => 'EXECUTE_SUCCESS',
],
'TaskTypeDescription' => [
'description' => '任务类型描述。',
'type' => 'string',
'example' => '创建续费订单',
],
'TryCount' => [
'description' => '任务详情重试次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ErrorMsg' => [
'description' => '任务执行失败消息。',
'type' => 'string',
'example' => 'The operation is successful.',
],
'FailReason' => [
'description' => '域名任务失败原因详情',
'type' => 'string',
'example' => '域名在万网预定业务存在购买记录',
],
],
],
],
],
],
'TotalItemNum' => [
'description' => '总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 1,\\n \\"RequestId\\": \\"6A2320E4-D870-49C9-A6DC-test\\",\\n \\"PageSize\\": 2,\\n \\"TotalPageNum\\": 1,\\n \\"Data\\": {\\n \\"TaskDetail\\": [\\n {\\n \\"UpdateTime\\": \\"2018-01-25 20:47:01\\",\\n \\"TaskDetailNo\\": \\"75addb07-28a3-450e-b5ec-test\\",\\n \\"CreateTime\\": \\"2018-01-25 20:46:57\\",\\n \\"InstanceId\\": \\"S20179H1BBI9test\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"TaskType\\": \\"ORDER_RENEW\\",\\n \\"TaskNo\\": \\"60d6e201-8ee5-47ab-8fdc-test\\",\\n \\"TaskResult\\": \\"12345\\",\\n \\"TaskStatusCode\\": 2,\\n \\"TaskStatus\\": \\"EXECUTE_SUCCESS\\",\\n \\"TaskTypeDescription\\": \\"创建续费订单\\",\\n \\"TryCount\\": 0,\\n \\"ErrorMsg\\": \\"The operation is successful.\\",\\n \\"FailReason\\": \\"域名在万网预定业务存在购买记录\\"\\n }\\n ]\\n },\\n \\"TotalItemNum\\": 1,\\n \\"NextPage\\": true\\n}","errorExample":""},{"type":"xml","example":"false\\n1\\n2\\n6A2320E4-D870-49C9-A6DC-test\\n1\\n\\n \\n example.com\\n S20179H1BBI9test\\n 60d6e201-8ee5-47ab-8fdc-test\\n 2\\n 2018-01-25 20:46:57\\n The operation is successful.\\n EXECUTE_SUCCESS\\n 创建续费订单\\n 0\\n ORDER_RENEW\\n 2018-01-25 20:47:01\\n 12345\\n 75addb07-28a3-450e-b5ec-test\\n \\n\\n1\\ntrue","errorExample":"\\n\\n \\n \\n 0\\n 75addb07-28a3-450e-b5ec-test\\n 60d6e201-8ee5-47ab-8fdc-test\\n 2018-01-25 20:46:57\\n S20179H1BBI9test\\n 2018-01-25 20:47:01\\n EXECUTE_SUCCESS\\n test.com\\n 2\\n The operation is successful.\\n ORDER_RENEW\\n \\n \\n 1\\n 2\\n 1\\n 6A2320E4-D870-49C9-A6DC-test\\n 1\\n"}]',
'title' => '分页查询指定域名任务的详情列表',
'summary' => '调用QueryTaskDetailList分页查询指定域名任务的详情列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainByDomainName' => [
'summary' => '调用QueryDomainByDomainName按域名查询域名信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => '域名所有者邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'RegistrationDate' => [
'description' => '注册时间。',
'type' => 'string',
'example' => '2017-12-07 17:02:13',
],
'RegistrationDateLong' => [
'description' => '注册时间的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1584675448000',
],
'RealNameStatus' => [
'description' => '域名实名认证状态。取值:'."\n"
.'- **NONAUDIT**:未实名认证。'."\n"
.'- **SUCCEED**:成功。'."\n"
.'- **FAILED**:审核失败。'."\n"
.'- **AUDITING**:审核中。',
'type' => 'string',
'example' => 'NONAUDIT',
],
'Premium' => [
'description' => '是否是溢价词。',
'type' => 'boolean',
'example' => 'false',
],
'DomainNameVerificationStatus' => [
'description' => '命名审核状态。取值:'."\n"
.'- **NONAUDIT**:未认证。'."\n"
.'- **SUCCEED**: 成功。'."\n"
.'- **FAILED**:审核失败。'."\n"
.'- **AUDITING**:审核中。',
'type' => 'string',
'example' => 'SUCCEED',
],
'ExpirationDateLong' => [
'description' => '到期时间的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1625111915000',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Dns' => [
'description' => 'dns列表。',
'type' => 'array',
'items' => [
'description' => 'DNS列表。',
'type' => 'string',
'example' => 'dns1.hichina.com,dns2.hichina.com',
],
],
],
],
'TransferOutStatus' => [
'description' => '域名转出状态。取值:'."\n"
.'- **NORMAL**:正常。'."\n"
.'- **PENDING**:正在转出万网。',
'type' => 'string',
'example' => 'NORMAL',
],
'ZhRegistrantOrganization' => [
'description' => '中文域名持有者。',
'type' => 'string',
'example' => '王先生',
],
'EmailVerificationClientHold' => [
'description' => '是否被clienthold。',
'type' => 'boolean',
'example' => 'false',
],
'EmailVerificationStatus' => [
'description' => '邮箱是否已通过验证。取值:'."\n"
.'- **0**:没有通过验证。'."\n"
.'- **1**:已通过验证。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RegistrantOrganization' => [
'description' => '域名所有者。',
'type' => 'string',
'example' => 'Test litm',
],
'TransferProhibitionLock' => [
'description' => '域名转移锁状态。取值:'."\n"
.'- **NONE_SETTING**:未设置。'."\n"
.'- **OPEN**:已开启。'."\n"
.'- **CLOSE**:已关闭。',
'type' => 'string',
'example' => 'CLOSE',
],
'DomainNameProxyService' => [
'description' => '是否已开启隐私保护状态。',
'type' => 'boolean',
'example' => 'false',
],
'RegistrantType' => [
'description' => '域名注册联系人类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。'."\n"
."\n",
'type' => 'string',
'example' => '1',
],
'RegistrantUpdatingStatus' => [
'description' => '域名持有者修改状态。取值:'."\n"
.'- **PENDING**:域名持有者信息修改中。'."\n"
.'- **NORMAL**:正常。',
'type' => 'string',
'example' => 'NORMAL',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '44101664-3E70-4F0E-89E5-CCB74BF*****',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'InstanceId' => [
'description' => '域名实例编号。',
'type' => 'string',
'example' => 'S20179H1BBI9****',
],
'ZhRegistrantName' => [
'description' => '中文联系人。',
'type' => 'string',
'example' => '王先生',
],
'ExpirationDate' => [
'description' => '到期时间。',
'type' => 'string',
'example' => '2019-12-07 17:02:13',
],
'RegistrantName' => [
'description' => '联系人。',
'type' => 'string',
'example' => 'Test litm',
],
'UserId' => [
'description' => '阿里云用户编号。',
'type' => 'string',
'example' => '121000000****',
],
'UpdateProhibitionLock' => [
'description' => '域名安全锁状态。取值: '."\n"
.'- **NONE_SETTING**:未设置。'."\n"
.'- **OPEN**:已开启。'."\n"
.'- **CLOSE**:已关闭。 ',
'type' => 'string',
'example' => 'CLOSE',
],
'DomainGroupId' => [
'description' => '域名分组ID,可使用查询域名分组的[QueryDomainGroupList](~~69362~~)接口获取',
'type' => 'integer',
'format' => 'int64',
'example' => '123456',
],
'Remark' => [
'description' => '域名备注。',
'type' => 'string',
'example' => '测试备注',
],
'DomainGroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => '测试分组',
],
'ExpirationDateStatus' => [
'description' => '域名过期状态。取值:'."\n"
.'- **1**:域名未过期。'."\n"
.'- **2**:域名已过期。'."\n"
.' ',
'type' => 'string',
'example' => '1',
],
'ExpirationCurrDateDiff' => [
'description' => '域名到期日和当前的时间的天数差值。',
'type' => 'integer',
'format' => 'int32',
'example' => '356',
],
'DomainType' => [
'description' => '域名类型。取值:'."\n"
."\n"
.'- New gTLD。 '."\n"
.'- gTLD。 '."\n"
.'- ccTLD。',
'type' => 'string',
'example' => 'gTLD',
],
'DomainStatus' => [
'description' => '域名状态。取值:'."\n"
."\n"
.'- 1:急需续费。 '."\n"
.'- 2:急需赎回。 '."\n"
.'- 3:正常。',
'type' => 'string',
'example' => '3',
],
'ResourceGroupId' => [
'description' => '资源组id。',
'type' => 'string',
'example' => 'rg-acfmw6bpc6n7zai',
],
'Tag' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '资源的标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => '费用',
],
'Vaue' => [
'description' => '标签值',
'type' => 'string',
'example' => '标签1',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Email\\": \\"username@example.com\\",\\n \\"RegistrationDate\\": \\"2017-12-07 17:02:13\\",\\n \\"RegistrationDateLong\\": 1584675448000,\\n \\"RealNameStatus\\": \\"NONAUDIT\\",\\n \\"Premium\\": false,\\n \\"DomainNameVerificationStatus\\": \\"SUCCEED\\",\\n \\"ExpirationDateLong\\": 1625111915000,\\n \\"DnsList\\": {\\n \\"Dns\\": [\\n \\"dns1.hichina.com,dns2.hichina.com\\"\\n ]\\n },\\n \\"TransferOutStatus\\": \\"NORMAL\\",\\n \\"ZhRegistrantOrganization\\": \\"王先生\\",\\n \\"EmailVerificationClientHold\\": false,\\n \\"EmailVerificationStatus\\": 1,\\n \\"RegistrantOrganization\\": \\"Test litm\\",\\n \\"TransferProhibitionLock\\": \\"CLOSE\\",\\n \\"DomainNameProxyService\\": false,\\n \\"RegistrantType\\": \\"1\\",\\n \\"RegistrantUpdatingStatus\\": \\"NORMAL\\",\\n \\"RequestId\\": \\"44101664-3E70-4F0E-89E5-CCB74BF*****\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"InstanceId\\": \\"S20179H1BBI9****\\",\\n \\"ZhRegistrantName\\": \\"王先生\\",\\n \\"ExpirationDate\\": \\"2019-12-07 17:02:13\\",\\n \\"RegistrantName\\": \\"Test litm\\",\\n \\"UserId\\": \\"121000000****\\",\\n \\"UpdateProhibitionLock\\": \\"CLOSE\\",\\n \\"DomainGroupId\\": 123456,\\n \\"Remark\\": \\"测试备注\\",\\n \\"DomainGroupName\\": \\"测试分组\\",\\n \\"ExpirationDateStatus\\": \\"1\\",\\n \\"ExpirationCurrDateDiff\\": 356,\\n \\"DomainType\\": \\"gTLD\\",\\n \\"DomainStatus\\": \\"3\\",\\n \\"ResourceGroupId\\": \\"rg-acfmw6bpc6n7zai\\",\\n \\"Tag\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"费用\\",\\n \\"Vaue\\": \\"标签1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"username@example.com\\n1584675448000\\n2017-12-07 17:02:13\\nNONAUDIT\\nSUCCEED\\nfalse\\n1625111915000\\n\\n dns1.hichina.com,dns2.hichina.com\\n\\nNORMAL\\n王先生\\nfalse\\n1\\nCLOSE\\nTest litm\\nfalse\\n1\\nNORMAL\\n44101664-3E70-4F0E-89E5-CCB74BF*****\\nS20179H1BBI9****\\nexample.com\\n王先生\\nTest litm\\n2019-12-07 17:02:13\\n121000000****\\nCLOSE","errorExample":"\\n\\n NORMAL\\n CLOSE\\n CLOSE\\n S20179H1BBI9test\\n 1\\n NONAUDIT\\n 121000000test\\n false\\n 2019-12-07 17:02:13\\n false\\n 1\\n test@alibaba-inc.com\\n 2017-12-07 17:02:13\\n false\\n test.com\\n NORMAL\\n Test litm\\n \\n dns1.hichina.com\\n dns2.hichina.com\\n \\n Test litm\\n"}]',
'title' => '根据域名名称查询域名信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryContactInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'ContactType',
'in' => 'query',
'schema' => [
'description' => '联系人类型。取值:'."\n"
.'- **registrant**:域名持有者。'."\n"
.'- **tech**:技术者。'."\n"
.'- **admin**:管理者。'."\n"
.'- **billing**:付费者。'."\n"
.' ',
'type' => 'string',
'required' => true,
'example' => 'admin',
'enum' => [
'registrant',
'admin',
'billing',
'tech',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ZhProvince' => [
'description' => '省份(中文)。',
'type' => 'string',
'example' => '浙江',
],
'Email' => [
'description' => '电子邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'Telephone' => [
'description' => '电话号码。',
'type' => 'string',
'example' => '1820000****',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'C39ECA8A-BB5E-4F92-B013-6A032FA06B04',
],
'Address' => [
'description' => '通讯地址(英文)。',
'type' => 'string',
'example' => 'xi hu qu *** jiedao *** xiaoqu *** zhuang 101',
],
'PostalCode' => [
'description' => '邮政编码。',
'type' => 'string',
'example' => '310024',
],
'ZhRegistrantName' => [
'description' => '联系人名称(中文)。',
'type' => 'string',
'example' => '张三',
],
'City' => [
'description' => '城市(英文)。',
'type' => 'string',
'example' => 'hang zhou shi',
],
'CreateDate' => [
'description' => '域名注册日期。',
'type' => 'string',
'example' => '2019-03-20 11:37:29',
],
'Province' => [
'description' => '省份(英文)。',
'type' => 'string',
'example' => 'zhe jiang',
],
'ZhCity' => [
'description' => '城市(中文)。',
'type' => 'string',
'example' => '杭州市',
],
'RegistrantName' => [
'description' => '联系人名称(英文)。',
'type' => 'string',
'example' => 'zhang san',
],
'ZhRegistrantOrganization' => [
'description' => '域名持有者名称(中文)。',
'type' => 'string',
'example' => '张三',
],
'Country' => [
'description' => '国家代码。例如,**CN**代表中国,**US**代表美国。',
'type' => 'string',
'example' => 'CN',
],
'RegistrantOrganization' => [
'description' => '域名持有者名称(英文)。',
'type' => 'string',
'example' => 'zhang san',
],
'TelExt' => [
'description' => '分机号码。',
'type' => 'string',
'example' => '1234',
],
'TelArea' => [
'description' => '电话国家代码。例如,中国的电话国家代码为**86**。',
'type' => 'string',
'example' => '86',
],
'ZhAddress' => [
'description' => '通讯地址(中文)。',
'type' => 'string',
'example' => '西湖区***街道***小区***幢101',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PostalCode\\": \\"310024\\",\\n \\"TelExt\\": \\"1234\\",\\n \\"ZhProvince\\": \\"浙江\\",\\n \\"ZhRegistrantOrganization\\": \\"张三\\",\\n \\"Telephone\\": \\"1820000****\\",\\n \\"RegistrantOrganization\\": \\"zhang san\\",\\n \\"City\\": \\"hang zhou shi\\",\\n \\"CreateDate\\": \\"2019-03-20 11:37:29\\",\\n \\"ZhCity\\": \\"杭州市\\",\\n \\"ZhRegistrantName\\": \\"张三\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"RequestId\\": \\"C39ECA8A-BB5E-4F92-B013-6A032FA06B04\\",\\n \\"TelArea\\": \\"86\\",\\n \\"Address\\": \\"xi hu qu *** jiedao *** xiaoqu *** zhuang 101\\",\\n \\"Country\\": \\"CN\\",\\n \\"RegistrantName\\": \\"zhang san\\",\\n \\"ZhAddress\\": \\"西湖区***街道***小区***幢101\\",\\n \\"Province\\": \\"zhe jiang\\"\\n}","errorExample":"{\\n \\"CreateDate\\": \\"2013-12-06 00:00:00\\",\\n \\"Address\\": \\"Ou Wo E Ou \\",\\n \\"TelExt\\": \\"\\",\\n \\"City\\": \\"Bei Jing Shi\\",\\n \\"Telephone\\": \\"1300000000\\",\\n \\"Country\\": \\"CN\\",\\n \\"TelArea\\": \\"86\\",\\n \\"Province\\": \\"Bei Jing\\",\\n \\"PostalCode\\": \\"111111\\",\\n \\"Email\\": \\"1300000000@aliyun.com\\",\\n \\"RequestId\\": \\"77B19432-82FF-4D25-82F9-CF83E19516F7\\",\\n \\"RegistrantName\\": \\"li Yun\\",\\n \\"RegistrantOrganization\\": \\"Li Yun\\"\\n}"},{"type":"xml","example":"张三\\n杭州市\\n1820000****\\n浙江\\nzhe jiang\\nCN\\n2019-03-20 11:37:29\\n86\\nhang zhou shi\\n张三\\n310024\\nusername@example.com\\nC39ECA8A-BB5E-4F92-B013-6A032FA06B04\\nxi hu qu *** jiedao *** xiaoqu *** zhuang 101\\nzhang san\\nzhang san\\n西湖区***街道***小区***幢101","errorExample":"\\n\\n 2013-12-06 00:00:00\\n Ou Wo E Ou \\n \\n Bei Jing Shi\\n 13000000000\\n CN\\n 86\\n Bei Jing\\n 111111\\n 13000000000@aliyun.com\\n DBBEFD6C-86F2-4C68-930A-21F8668BB6E8\\n li Yun\\n Li Yun\\n"}]',
'title' => '查询域名联系人信息',
'summary' => '调用QueryContactInfo查询域名联系人信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainByInstanceId' => [
'summary' => '调用QueryDomainByInstanceId根据域名实例编号查询域名的基本信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain2QWIHA',
],
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号,通过查询域名列表[QueryDomainList](~~67712~~)接口获取。',
'type' => 'string',
'required' => true,
'example' => 'S20131205001****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => '域名所有者邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'RegistrationDate' => [
'description' => '域名注册时间。',
'type' => 'string',
'example' => '2017-12-07 17:02:13',
],
'RegistrationDateLong' => [
'description' => '注册时间的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1625111915000',
],
'RealNameStatus' => [
'description' => '域名实名认证状态。取值:'."\n"
.'- **NONAUDIT**:未实名认证。'."\n"
.'- **SUCCEED**:实名认证成功。'."\n"
.'- **FAILED**:实名认证审核失败。'."\n"
.'- **AUDITING**:实名认证审核中。'."\n"
."\n"
.'> 域名实名认证状态是域名命名审核和实名审核的组合状态,只有域名命名审核和实名审核均通过才算域名实名认证成功。',
'type' => 'string',
'example' => 'NONAUDIT',
],
'Premium' => [
'description' => '是否是溢价词。取值:'."\n"
.'- **true**:溢价词。'."\n"
.'- **false**:非溢价词。',
'type' => 'boolean',
'example' => 'false',
],
'DomainNameVerificationStatus' => [
'description' => '域名命名审核状态。取值:'."\n"
.'- **NONAUDIT**:未认证。'."\n"
.'- **SUCCEED**:成功。'."\n"
.'- **FAILED**:审核失败。'."\n"
.'- **AUDITING**:审核中。'."\n"
.' ',
'type' => 'string',
'example' => 'NONAUDIT',
],
'ExpirationDateLong' => [
'description' => '到期时间的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1625111915000',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Dns' => [
'description' => 'DNS列表。',
'type' => 'array',
'items' => [
'description' => '返回域名已配置的DNS列表。',
'type' => 'string',
'example' => 'dns1.hichina.com,dns2.hichina.com',
],
],
],
],
'TransferOutStatus' => [
'description' => '域名转出状态。取值:'."\n"
.'- **NORMAL**:正常。'."\n"
.'- **PENDING**:正在转出阿里云。'."\n"
.' ',
'type' => 'string',
'example' => 'NORMAL',
],
'ZhRegistrantOrganization' => [
'description' => '中文域名持有者。'."\n"
."\n"
.'> 该参数仅适用于中国站。',
'type' => 'string',
'example' => '李四',
],
'EmailVerificationClientHold' => [
'description' => '域名是否被暂停解析。取值:'."\n"
."\n"
.'- **false**:域名未被暂停解析。'."\n"
.'- **true**:域名已被暂停解析。'."\n",
'type' => 'boolean',
'example' => 'false',
],
'EmailVerificationStatus' => [
'description' => '域名持有者邮箱是否已通过验证。取值:'."\n"
.'- **0**:没有通过验证。'."\n"
.'- **1**:已通过验证。'."\n"
.' ',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RegistrantOrganization' => [
'description' => '域名持有者。',
'type' => 'string',
'example' => 'Test litm',
],
'TransferProhibitionLock' => [
'description' => '域名转移锁状态。取值:'."\n"
.'- **NONE_SETTING**:未设置。'."\n"
.'- **OPEN**:已开启。'."\n"
.'- **CLOSE**:已关闭。'."\n"
.' ',
'type' => 'string',
'example' => 'CLOSE',
],
'DomainNameProxyService' => [
'description' => '是否已开启域名隐私保护服务。',
'type' => 'boolean',
'example' => 'false',
],
'RegistrantType' => [
'description' => '域名注册联系人类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。'."\n"
.' ',
'type' => 'string',
'example' => '1',
],
'RegistrantUpdatingStatus' => [
'description' => '域名持有者修改状态。取值:'."\n"
.'- **PENDING**:域名持有者信息修改中。'."\n"
.'- **NORMAL**:正常。',
'type' => 'string',
'example' => 'NORMAL',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '23C9B3C4-9E2C-4405-A88D-BD33E459D140',
],
'DomainName' => [
'description' => '查询的域名。',
'type' => 'string',
'example' => 'example.com',
],
'InstanceId' => [
'description' => '域名实例编号。',
'type' => 'string',
'example' => 'S20179H1BBI9test',
],
'ZhRegistrantName' => [
'description' => '中文联系人。'."\n"
."\n"
.'> 该参数仅适用于中国站。',
'type' => 'string',
'example' => '李四',
],
'ExpirationDate' => [
'description' => '查询的域名到期时间。',
'type' => 'string',
'example' => '2019-12-07 17:02:13',
],
'RegistrantName' => [
'description' => '联系人名称。',
'type' => 'string',
'example' => 'Test litm',
],
'UserId' => [
'description' => '阿里云用户编号(阿里云账号UID)。',
'type' => 'string',
'example' => '121000000****',
],
'UpdateProhibitionLock' => [
'description' => '域名安全锁状态。取值:'."\n"
.'- **NONE_SETTING**:未设置。'."\n"
.'- **OPEN**:已开启。'."\n"
.'- **CLOSE**:已关闭。'."\n"
.' ',
'type' => 'string',
'example' => 'CLOSE',
],
'DomainGroupId' => [
'title' => '域名分组ID',
'description' => '域名分组ID,可通过[QueryDomainGroupList](https://help.aliyun.com/document_detail/69362.html)接口获取。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1234',
],
'Remark' => [
'title' => '备注',
'description' => '域名备注。',
'type' => 'string',
'example' => '测试备注',
],
'DomainGroupName' => [
'title' => '域名分组名称',
'description' => '域名分组名称。',
'type' => 'string',
'example' => '测试分组',
],
'ExpirationDateStatus' => [
'description' => '域名过期状态。取值:'."\n"
.'- **1**:域名未过期。'."\n"
.'- **2**:域名已过期。'."\n"
.' ',
'type' => 'string',
'example' => '1',
],
'ExpirationCurrDateDiff' => [
'description' => '域名到期日和当前的时间的天数差值。',
'type' => 'integer',
'format' => 'int32',
'example' => '356',
],
'DomainType' => [
'description' => '域名类型。取值:'."\n"
."\n"
.'- New gTLD。 '."\n"
.'- gTLD。 '."\n"
.'- ccTLD。',
'type' => 'string',
'example' => 'gTLD',
],
'DomainStatus' => [
'description' => '域名状态。取值:'."\n"
."\n"
.'- 1:急需续费。 '."\n"
.'- 2:急需赎回。 '."\n"
.'- 3:正常。',
'type' => 'string',
'example' => '1',
],
'ResourceGroupId' => [
'description' => '资源组id。',
'type' => 'string',
'example' => 'rg-acfmw6bpc6n7zai',
],
'Tag' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '资源标签',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => '续费',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => '标签1',
],
],
],
],
],
],
'DomainLifecycleStatus' => [
'type' => 'string',
],
'PrivacyServiceStatus' => [
'type' => 'string',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Email\\": \\"username@example.com\\",\\n \\"RegistrationDate\\": \\"2017-12-07 17:02:13\\",\\n \\"RegistrationDateLong\\": 1625111915000,\\n \\"RealNameStatus\\": \\"NONAUDIT\\",\\n \\"Premium\\": false,\\n \\"DomainNameVerificationStatus\\": \\"NONAUDIT\\",\\n \\"ExpirationDateLong\\": 1625111915000,\\n \\"DnsList\\": {\\n \\"Dns\\": [\\n \\"dns1.hichina.com,dns2.hichina.com\\"\\n ]\\n },\\n \\"TransferOutStatus\\": \\"NORMAL\\",\\n \\"ZhRegistrantOrganization\\": \\"李四\\",\\n \\"EmailVerificationClientHold\\": false,\\n \\"EmailVerificationStatus\\": 1,\\n \\"RegistrantOrganization\\": \\"Test litm\\",\\n \\"TransferProhibitionLock\\": \\"CLOSE\\",\\n \\"DomainNameProxyService\\": false,\\n \\"RegistrantType\\": \\"1\\",\\n \\"RegistrantUpdatingStatus\\": \\"NORMAL\\",\\n \\"RequestId\\": \\"23C9B3C4-9E2C-4405-A88D-BD33E459D140\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"InstanceId\\": \\"S20179H1BBI9test\\",\\n \\"ZhRegistrantName\\": \\"李四\\",\\n \\"ExpirationDate\\": \\"2019-12-07 17:02:13\\",\\n \\"RegistrantName\\": \\"Test litm\\",\\n \\"UserId\\": \\"121000000****\\",\\n \\"UpdateProhibitionLock\\": \\"CLOSE\\",\\n \\"DomainGroupId\\": 1234,\\n \\"Remark\\": \\"测试备注\\",\\n \\"DomainGroupName\\": \\"测试分组\\",\\n \\"ExpirationDateStatus\\": \\"1\\",\\n \\"ExpirationCurrDateDiff\\": 356,\\n \\"DomainType\\": \\"gTLD\\",\\n \\"DomainStatus\\": \\"1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmw6bpc6n7zai\\",\\n \\"Tag\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"续费\\",\\n \\"Value\\": \\"标签1\\"\\n }\\n ]\\n },\\n \\"DomainLifecycleStatus\\": \\"\\",\\n \\"PrivacyServiceStatus\\": \\"\\"\\n}","errorExample":"{\\n \\"dnsList\\": [\\n \\"dns1.hichina.com\\",\\n \\"dns2.hichina.com\\"\\n ],\\n \\"domainName\\": \\"test.com\\",\\n \\"domainNameProxyService\\": false,\\n \\"email\\": \\"test@alibaba-inc.com\\",\\n \\"emailVerificationClientHold\\": false,\\n \\"emailVerificationStatus\\": 1,\\n \\"expirationDate\\": \\"2019-12-07 17:02:13\\",\\n \\"instanceId\\": \\"S20179H1BBI9test\\",\\n \\"premium\\": false,\\n \\"realNameStatus\\": \\"NONAUDIT\\",\\n \\"domainNameVerificationStatus\\": \\"NONAUDIT\\",\\n \\"registrantInfoStatus\\": \\"NORMAL\\",\\n \\"registrantName\\": \\"Test litm\\",\\n \\"registrantOrganization\\": \\"Test litm\\",\\n \\"registrationDate\\": \\"2017-12-07 17:02:13\\",\\n \\"transferOutStatus\\": \\"NORMAL\\",\\n \\"transferProhibitionLock\\": \\"CLOSE\\",\\n \\"updateProhibitionLock\\": \\"CLOSE\\",\\n \\"userId\\": \\"121000000test\\"\\n}"},{"type":"xml","example":"\\r\\n NORMAL\\r\\n CLOSE\\r\\n CLOSE\\r\\n S20179H1BBI9test\\r\\n 1\\r\\n NONAUDIT\\r\\n NONAUDIT\\r\\n 121000000****\\r\\n false\\r\\n 2019-12-07 17:02:13\\r\\n false\\r\\n 1\\r\\n username@example.com\\r\\n 2017-12-07 17:02:13\\r\\n false\\r\\n example.com\\r\\n NORMAL\\r\\n Test litm\\r\\n \\r\\n dns1.hichina.com\\r\\n dns2.hichina.com\\r\\n \\r\\n Test litm\\r\\n 23C9B3C4-9E2C-4405-A88D-BD33E459D140\\r\\n","errorExample":"\\n\\n NORMAL\\n CLOSE\\n CLOSE\\n S20179H1BBI9test\\n 1\\n NONAUDIT\\n NONAUDIT\\n 121000000test\\n false\\n 2019-12-07 17:02:13\\n false\\n 1\\n test@alibaba-inc.com\\n 2017-12-07 17:02:13\\n false\\n test.com\\n NORMAL\\n Test litm\\n \\n dns1.hichina.com\\n dns2.hichina.com\\n \\n Test litm\\n"}]',
'title' => '根据域名实例编号查询域名信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainList' => [
'summary' => '分页查询自己账户下的域名列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain7EGRPF',
],
],
'parameters' => [
[
'name' => 'EndExpirationDate',
'in' => 'query',
'schema' => [
'description' => '查询域名到期日期的结束时间,计算方式为UTC时间1970年1月1日0点距离需要查询时间的毫秒数,目前仅支持按天查询。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'StartExpirationDate',
'in' => 'query',
'schema' => [
'description' => '查询域名到期日期的开始时间,计算方式为UTC时间1970年1月1日0点距离需要查询时间的毫秒数,目前仅支持按天查询。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认值为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'QueryType',
'in' => 'query',
'schema' => [
'description' => '列表查询类型。取值:'."\n"
.'- **1**:急需续费列表。'."\n"
.'- **2**:急需赎回列表。'."\n"
.' ',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'StartRegistrationDate',
'in' => 'query',
'schema' => [
'description' => '查询域名注册日期的开始时间,计算方式为UTC时间1970年1月1日0点距离现在的毫秒数,目前仅支持按天查询。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndRegistrationDate',
'in' => 'query',
'schema' => [
'description' => '查询域名注册日期的结束时间,计算方式为UTC时间1970年1月1日0点距离现在的毫秒数,目前仅支持按天查询。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名,可在域名列表中搜索该域名。',
'type' => 'string',
'required' => false,
'example' => 'test.com',
],
],
[
'name' => 'OrderByType',
'in' => 'query',
'schema' => [
'description' => '业务内容(如注册时间、过期时间)的排序顺序。取值:'."\n"
.'- **ASC**:升序。'."\n"
.'- **DESC**:倒序。'."\n"
.'> 不传此参数默认为**DESC**。',
'type' => 'string',
'required' => false,
'example' => 'ASC',
],
],
[
'name' => 'OrderKeyType',
'in' => 'query',
'schema' => [
'description' => '排序字段。取值:'."\n"
.'- **RegistrationDate**:根据注册时间排序。'."\n"
.'- **ExpirationDate**:根据到期时间排序。'."\n"
."\n"
.'> 不传此参数时,默认以入库时间排序。',
'type' => 'string',
'required' => false,
'example' => 'RegistrationDate',
],
],
[
'name' => 'ProductDomainType',
'in' => 'query',
'schema' => [
'description' => '域名类型。取值:'."\n"
.'- **New gTLD**:新顶级域。'."\n"
.'- **gTLD**:通用顶级域。'."\n"
.'- **ccTLD**:国别域。'."\n"
.' ',
'type' => 'string',
'required' => false,
'example' => 'New gTLD',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '域名列表的分页页码。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '域名列表的分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => '域名分组ID,可使用查询域名分组的[QueryDomainGroupList](~~69362~~)接口获取。'."\n"
.'域名分组ID。'."\n",
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组id。',
'type' => 'string',
'required' => false,
'example' => 'rg-aek2indvyxgpfti',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => '备注',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => '标签1',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
[
'name' => 'Ccompany',
'in' => 'query',
'schema' => [
'description' => '域名所有者名称。',
'type' => 'string',
'required' => false,
'example' => '广州金烨再生资源回收有限公司',
],
],
[
'name' => 'Registrar',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'Dns',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。',
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前域名列表的分页页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E',
],
'PageSize' => [
'description' => '域名分页列表的大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalPageNum' => [
'description' => '域名列表的总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Domain' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'description' => '域名列表。',
'type' => 'object',
'properties' => [
'DomainAuditStatus' => [
'description' => '域名实名认证状态。取值:'."\n"
.'- **FAILED**:实名认证失败。'."\n"
.'- **SUCCEED**:实名认证成功。'."\n"
.'- **NONAUDIT**:未实名认证。'."\n"
.'- **AUDITING**:审核中。'."\n"
.' ',
'type' => 'string',
'example' => 'FAILED',
],
'DomainGroupId' => [
'description' => '域名分组编号。',
'type' => 'string',
'example' => '123456',
],
'Remark' => [
'description' => '域名备注。',
'type' => 'string',
'example' => '测试备注',
],
'DomainGroupName' => [
'description' => '域名分组名称',
'type' => 'string',
'example' => '测试分组',
],
'RegistrationDate' => [
'description' => '注册时间。',
'type' => 'string',
'example' => '2017-11-02 04:00:45',
],
'InstanceId' => [
'description' => '实例编号。',
'type' => 'string',
'example' => 'ST20151102120031118',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'test.com',
],
'ExpirationDateStatus' => [
'description' => '域名过期状态。取值:'."\n"
.'- **1**:域名未过期。'."\n"
.'- **2**:域名已过期。'."\n"
.' ',
'type' => 'string',
'example' => '1',
],
'ExpirationDate' => [
'description' => '域名到期日期。',
'type' => 'string',
'example' => '2017-11-02 04:00:45',
],
'RegistrantType' => [
'description' => '域名注册类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。'."\n"
.' ',
'type' => 'string',
'example' => '1',
],
'ExpirationDateLong' => [
'description' => '域名到期时长,UTC时间1970年1月1日0点距离域名到期日的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1522080000000',
],
'ExpirationCurrDateDiff' => [
'description' => '域名到期日和当前的时间的天数差值。',
'type' => 'integer',
'format' => 'int32',
'example' => '-30',
],
'Premium' => [
'description' => '是否是溢价域名。',
'type' => 'boolean',
'example' => 'true',
],
'RegistrationDateLong' => [
'description' => '注册时长,UTC时间1970年1月1日0点距离注册时间的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1522080000000',
],
'ProductId' => [
'description' => '产品ID。',
'type' => 'string',
'example' => '2a',
],
'DomainStatus' => [
'description' => '域名状态。取值:'."\n"
.'- **1**:急需续费。'."\n"
.'- **2**:急需赎回。'."\n"
.'- **3**:正常。'."\n"
.' ',
'type' => 'string',
'example' => '3',
],
'DomainType' => [
'description' => '域名类型。取值:'."\n"
.'- **New gTLD**。'."\n"
.'- **gTLD**。'."\n"
.'- **ccTLD**。',
'type' => 'string',
'example' => 'gTLD',
],
'ResourceGroupId' => [
'description' => '域名资源组id。',
'type' => 'string',
'example' => 'rg-aek2yyciz557g3q',
],
'Tag' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '域名标签列表。',
'type' => 'array',
'items' => [
'description' => '域名标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => '费用',
],
'Value' => [
'description' => '标签的值。',
'type' => 'string',
'example' => '标签1',
],
],
],
],
],
],
'Ccompany' => [
'description' => '域名所有者名称。',
'type' => 'string',
'example' => '广州森林广告装饰有限公司',
],
'ChgholderStatus' => [
'description' => '域名过户状态。取值:'."\n"
."\n"
.'- **0**:域名状态正常。'."\n"
.'- **1**:域名正在过户中。'."\n"
.'- **2**:域名过户失败。',
'type' => 'string',
'example' => '0',
],
'Registrar' => [
'type' => 'string',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsList' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
'TotalItemNum' => [
'description' => '域名总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 0,\\n \\"RequestId\\": \\"B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E\\",\\n \\"PageSize\\": 5,\\n \\"TotalPageNum\\": 1,\\n \\"Data\\": {\\n \\"Domain\\": [\\n {\\n \\"DomainAuditStatus\\": \\"FAILED\\",\\n \\"DomainGroupId\\": \\"123456\\",\\n \\"Remark\\": \\"测试备注\\",\\n \\"DomainGroupName\\": \\"测试分组\\",\\n \\"RegistrationDate\\": \\"2017-11-02 04:00:45\\",\\n \\"InstanceId\\": \\"ST20151102120031118\\",\\n \\"DomainName\\": \\"test.com\\",\\n \\"ExpirationDateStatus\\": \\"1\\",\\n \\"ExpirationDate\\": \\"2017-11-02 04:00:45\\",\\n \\"RegistrantType\\": \\"1\\",\\n \\"ExpirationDateLong\\": 1522080000000,\\n \\"ExpirationCurrDateDiff\\": -30,\\n \\"Premium\\": true,\\n \\"RegistrationDateLong\\": 1522080000000,\\n \\"ProductId\\": \\"2a\\",\\n \\"DomainStatus\\": \\"3\\",\\n \\"DomainType\\": \\"gTLD\\",\\n \\"ResourceGroupId\\": \\"rg-aek2yyciz557g3q\\",\\n \\"Tag\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"费用\\",\\n \\"Value\\": \\"标签1\\"\\n }\\n ]\\n },\\n \\"Ccompany\\": \\"广州森林广告装饰有限公司\\",\\n \\"ChgholderStatus\\": \\"0\\",\\n \\"Registrar\\": \\"\\",\\n \\"DnsList\\": {\\n \\"DnsList\\": [\\n \\"\\"\\n ]\\n }\\n }\\n ]\\n },\\n \\"TotalItemNum\\": 1,\\n \\"NextPage\\": false\\n}","errorExample":"{\\n \\"Data\\": {\\n \\"Domain\\": [\\n {\\n \\"ExpirationDate\\": \\"Nov 02,2019 04:00:45\\",\\n \\"InstanceId\\": \\"ST2015110212003800001928\\",\\n \\"RegistrationDate\\": \\"Nov 02,2017 04:00:45\\",\\n \\"DomainName\\": \\"fds234sdf.net\\",\\n \\"DomainType\\": \\"gTLD\\"\\n }\\n ]\\n },\\n \\"TotalItemNum\\": 1,\\n \\"PageSize\\": 5,\\n \\"CurrentPageNum\\": 0,\\n \\"RequestId\\": \\"77F90DA6-89AB-4074-80F3-E595CB57DF98\\",\\n \\"PrePage\\": false,\\n \\"TotalPageNum\\": 1,\\n \\"NextPage\\": false\\n}"},{"type":"xml","example":"\\n\\n \\n \\n Nov 02,2019 04:00:45\\n ST20151102120031118\\n Nov 02,2017 04:00:45\\n test.com\\n gTLD\\n \\n \\n 1\\n 5\\n 0\\n B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E\\n false\\n 1\\n false\\n","errorExample":"\\n\\n \\n \\n Nov 02,2019 04:00:45\\n ST20151102120031118\\n Nov 02,2017 04:00:45\\n test.com\\n gTLD\\n \\n \\n 1\\n 5\\n 0\\n B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E\\n false\\n 1\\n false\\n"}]',
'title' => '分页查询自己账户下的域名列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ScrollDomainList' => [
'summary' => '调用ScrollDomainList翻页遍历域名列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'EndExpirationDate',
'in' => 'query',
'schema' => [
'description' => '查询域名到期日期范围的结束时间,计算方式为UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541520000000',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'StartExpirationDate',
'in' => 'query',
'schema' => [
'description' => '查询域名到期日期范围的开始时间,计算方式为UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541520000000',
],
],
[
'name' => 'ProductDomainType',
'in' => 'query',
'schema' => [
'description' => '域名类型。取值:'."\n"
.'- **New gTLD**。'."\n"
.'- **gTLD**。'."\n"
.'- **ccTLD**。'."\n"
.'- **other**。',
'type' => 'string',
'required' => false,
'example' => 'gTLD',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '域名列表的分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '500',
'minimum' => '1',
'example' => '50',
'default' => '200',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => '域名分组ID,可通过[QueryDomainGroupList](https://help.aliyun.com/document_detail/69362.html)接口获取。'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'DomainStatus',
'in' => 'query',
'schema' => [
'description' => '域名状态。取值:'."\n"
.'- **0**:全部。'."\n"
.'- **1**:急需续费。'."\n"
.'- **2**:急需赎回。'."\n"
.'- **3**:正常。'."\n"
.'- **4**:正在转出万网。 '."\n"
.'- **5**:域名持有者信息修改中。'."\n"
.'- **6**:未实名认证。'."\n"
.'- **7**:审核失败,重新实名认证。'."\n"
.'- **8**:审核中。'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'EndLength',
'in' => 'query',
'schema' => [
'description' => '查询域名长度范围的结束长度。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
],
],
[
'name' => 'Excluded',
'in' => 'query',
'schema' => [
'description' => '排除关键字。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ExcludedPrefix',
'in' => 'query',
'schema' => [
'description' => '开头排除关键字。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ExcludedSuffix',
'in' => 'query',
'schema' => [
'description' => '结束排除关键字。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'Form',
'in' => 'query',
'schema' => [
'description' => '域名组成信息。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => [
'description' => '关键字。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'KeyWordPrefix',
'in' => 'query',
'schema' => [
'description' => '开头关键字。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'KeyWordSuffix',
'in' => 'query',
'schema' => [
'description' => '结束关键字。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'StartLength',
'in' => 'query',
'schema' => [
'description' => '查询域名长度范围的开始长度。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'TradeType',
'in' => 'query',
'schema' => [
'description' => '发布状态。取值:'."\n"
.'- **2**:已发布一口价。'."\n"
.'- **3**:已发布线上议价。'."\n"
.'- **4**:已发布竞价。'."\n"
.'- **6**:已发布带价push。'."\n"
.'- **-1**:未发布域名交易。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'Suffixs',
'in' => 'query',
'schema' => [
'description' => '查询后缀列表,以逗号(,)隔开。',
'type' => 'string',
'required' => false,
'example' => 'com',
],
],
[
'name' => 'StartRegistrationDate',
'in' => 'query',
'schema' => [
'description' => '查询域名注册日期范围的开始时间,计算方式为UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541520000000',
],
],
[
'name' => 'EndRegistrationDate',
'in' => 'query',
'schema' => [
'description' => '查询域名注册日期范围的结束时间,计算方式为UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541520000000',
],
],
[
'name' => 'ScrollId',
'in' => 'query',
'schema' => [
'description' => '翻页遍历ID(技术参数)。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组id。',
'type' => 'string',
'required' => false,
'example' => 'rg-acfmw6bpc6n7zai',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '722AB7F5-61F0-408C-A012-4784AFD34083',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'ScrollId' => [
'description' => '翻页遍历ID。',
'type' => 'string',
'example' => 'test',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Domain' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'description' => '域名列表。',
'type' => 'object',
'properties' => [
'DomainAuditStatus' => [
'description' => '域名实名认证状态。取值:'."\n"
.'- **FAILED**:实名认证失败。'."\n"
.'- **SUCCEED**:实名认证成功。'."\n"
.'- **NONAUDIT**:未实名认证。'."\n"
.'- **AUDITING**:审核中。',
'type' => 'string',
'example' => 'NONAUDIT',
],
'DomainGroupId' => [
'description' => '域名分组编号。'."\n",
'type' => 'string',
'example' => '1234',
],
'Remark' => [
'description' => '域名备注。',
'type' => 'string',
'example' => '测试域名',
],
'DomainGroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => '测试分组',
],
'ZhRegistrantOrganization' => [
'description' => '中文域名持有者。',
'type' => 'string',
'example' => '阿里云',
],
'RegistrantOrganization' => [
'description' => '域名持有者。',
'type' => 'string',
'example' => 'alibaba cloud',
],
'RegistrationDate' => [
'description' => '注册时间。'."\n",
'type' => 'string',
'example' => '2017-02-15 00:00:00',
],
'InstanceId' => [
'description' => '域名实例编号。',
'type' => 'string',
'example' => 'S1234',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'ExpirationDateStatus' => [
'description' => '域名过期状态。取值:'."\n"
.'- **1**:域名未过期。'."\n"
.'- **2**:域名已过期。',
'type' => 'string',
'example' => '1',
],
'ExpirationDate' => [
'description' => '域名到期日。'."\n",
'type' => 'string',
'example' => '2019-02-15 17:30:35',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Dns' => [
'description' => 'dns列表。',
'type' => 'array',
'items' => [
'description' => 'DNS列表。',
'type' => 'string',
'example' => '["dns15.hichina.com", "dns16.hichina.com"]',
],
],
],
],
'Email' => [
'description' => '邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'RegistrantType' => [
'description' => '域名注册类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。',
'type' => 'string',
'example' => '1',
],
'ExpirationDateLong' => [
'description' => '域名到期日,UTC时间1970年1月1日0点距离域名到期日的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1550223035000',
],
'ExpirationCurrDateDiff' => [
'description' => '到期日和当前日期差。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Premium' => [
'description' => '是否是溢价词。',
'type' => 'boolean',
'example' => 'false',
],
'RegistrationDateLong' => [
'description' => '域名注册时间,计算方式为UTC时间1970年1月1日0点距离注册时间的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1487088000000',
],
'ProductId' => [
'description' => '产品ID。',
'type' => 'string',
'example' => '2a',
],
'DomainStatus' => [
'description' => '域名状态。取值:'."\n"
.'- **1**:急需续费。'."\n"
.'- **2**:急需赎回。'."\n"
.'- **3**:正常。'."\n"
.'- **4**:转出中。'."\n"
.'- **5**:域名持有者信息修改中。'."\n"
.'- **6**:未实名认证。'."\n"
.'- **7**:实名认证失败。'."\n"
.'- **8**:实名认证审核中。',
'type' => 'string',
'example' => '3',
],
'DomainType' => [
'description' => '域名类型。取值:'."\n"
.'- **New gTLD**。'."\n"
.'- **gTLD**。'."\n"
.'- **ccTLD**。',
'type' => 'string',
'example' => 'gTLD',
],
'ResourceGroupId' => [
'description' => '资源组id。',
'type' => 'string',
'example' => 'rg-aek2yyciz557g3q',
],
'Tag' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '资源标签。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'testKey',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'testValue',
],
],
],
],
],
],
],
],
],
],
],
'TotalItemNum' => [
'description' => '剩余总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"722AB7F5-61F0-408C-A012-4784AFD34083\\",\\n \\"PageSize\\": 50,\\n \\"ScrollId\\": \\"test\\",\\n \\"Data\\": {\\n \\"Domain\\": [\\n {\\n \\"DomainAuditStatus\\": \\"NONAUDIT\\",\\n \\"DomainGroupId\\": \\"1234\\",\\n \\"Remark\\": \\"测试域名\\",\\n \\"DomainGroupName\\": \\"测试分组\\",\\n \\"ZhRegistrantOrganization\\": \\"阿里云\\",\\n \\"RegistrantOrganization\\": \\"alibaba cloud\\",\\n \\"RegistrationDate\\": \\"2017-02-15 00:00:00\\",\\n \\"InstanceId\\": \\"S1234\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"ExpirationDateStatus\\": \\"1\\",\\n \\"ExpirationDate\\": \\"2019-02-15 17:30:35\\",\\n \\"DnsList\\": {\\n \\"Dns\\": [\\n \\"[\\\\\\"dns15.hichina.com\\\\\\", \\\\\\"dns16.hichina.com\\\\\\"]\\"\\n ]\\n },\\n \\"Email\\": \\"username@example.com\\",\\n \\"RegistrantType\\": \\"1\\",\\n \\"ExpirationDateLong\\": 1550223035000,\\n \\"ExpirationCurrDateDiff\\": 10,\\n \\"Premium\\": false,\\n \\"RegistrationDateLong\\": 1487088000000,\\n \\"ProductId\\": \\"2a\\",\\n \\"DomainStatus\\": \\"3\\",\\n \\"DomainType\\": \\"gTLD\\",\\n \\"ResourceGroupId\\": \\"rg-aek2yyciz557g3q\\",\\n \\"Tag\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"TotalItemNum\\": 200\\n}","errorExample":"{\\n \\"Data\\":{\\n \\"Domain\\":[\\n {\\n \\"DnsList\\":{\\n \\"Dns\\":[\\n \\"dns15.hichina.com\\",\\n \\"dns16.hichina.com\\"\\n ]\\n },\\n \\"DomainAuditStatus\\":\\"FAILED\\",\\n \\"DomainGroupId\\":\\"-1\\",\\n \\"DomainGroupName\\":\\"未分组\\",\\n \\"DomainName\\":\\"test.com\\",\\n \\"DomainStatus\\":\\"7\\",\\n \\"DomainType\\":\\"gTLD\\",\\n \\"Email\\":\\"test@a.com\\",\\n \\"ExpirationCurrDateDiff\\":85,\\n \\"ExpirationDate\\":\\"2019-02-15 17:30:35\\",\\n \\"ExpirationDateLong\\":1550223035000,\\n \\"ExpirationDateStatus\\":\\"1\\",\\n \\"InstanceId\\":\\"S2017000000\\",\\n \\"Premium\\":false,\\n \\"ProductId\\":\\"2a\\",\\n \\"RegistrantOrganization\\":\\"Test\\",\\n \\"RegistrantType\\":\\"1\\",\\n \\"RegistrationDate\\":\\"2017-02-15 00:00:00\\",\\n \\"RegistrationDateLong\\":1487088000000,\\n \\"Remark\\":\\"备注\\",\\n \\"ZhRegistrantOrganization\\":\\"测试\\"\\n },\\n {\\n \\"DnsList\\":{\\n \\"Dns\\":[\\n \\"dns11.hichina.com\\",\\n \\"dns12.hichina.com\\"\\n ]\\n },\\n \\"DomainAuditStatus\\":\\"SUCCEED\\",\\n \\"DomainGroupId\\":\\"-1\\",\\n \\"DomainGroupName\\":\\"未分组\\",\\n \\"DomainName\\":\\"test1.com\\",\\n \\"DomainStatus\\":\\"3\\",\\n \\"DomainType\\":\\"gTLD\\",\\n \\"Email\\":\\"test@a.com\\",\\n \\"ExpirationCurrDateDiff\\":181,\\n \\"ExpirationDate\\":\\"2019-05-22 16:23:19\\",\\n \\"ExpirationDateLong\\":1558513399000,\\n \\"ExpirationDateStatus\\":\\"1\\",\\n \\"InstanceId\\":\\"S2000000000000\\",\\n \\"Premium\\":false,\\n \\"ProductId\\":\\"2a\\",\\n \\"RegistrantOrganization\\":\\"test\\",\\n \\"RegistrantType\\":\\"1\\",\\n \\"RegistrationDate\\":\\"2018-05-22 16:23:19\\",\\n \\"RegistrationDateLong\\":1526977399000,\\n \\"Remark\\":\\"备注\\",\\n \\"ZhRegistrantOrganization\\":\\"测试\\"\\n }\\n ]\\n },\\n \\"PageSize\\":2,\\n \\"RequestId\\":\\"9012EED7-4B99-4BC3-B04F-4BA637A90DC7\\",\\n \\"ScrollId\\":\\"eJxlUk2P2yAQ\\",\\n \\"TotalItemNum\\":539\\n}"},{"type":"xml","example":"\\n\\n \\n \\n dns15.hichina.com\\n dns16.hichina.com\\n \\n FAILED\\n -1\\n 未分组\\n example.com\\n 7\\n gTLD\\n username@example.com\\n 85\\n 2019-02-15 17:30:35\\n 1550223035000\\n 1\\n S2017000000\\n false\\n 2a\\n Test\\n 1\\n 2017-02-15 00:00:00\\n 1487088000000\\n 备注\\n 测试\\n \\n \\n \\n dns11.hichina.com\\n dns12.hichina.com\\n \\n SUCCEED\\n -1\\n 未分组\\n example.com\\n 3\\n gTLD\\n username@example.com\\n 181\\n 2019-05-22 16:23:19\\n 1558513399000\\n 1\\n S2000000000000\\n false\\n 2a\\n test\\n 1\\n 2018-05-22 16:23:19\\n 1526977399000\\n 备注\\n 测试\\n \\n\\n2\\n9012EED7-4B99-4BC3-B04F-4BA637A90DC7\\neJxlUk2P2yAQ\\n539\\n","errorExample":"\\n \\n 539\\n 11\\n eJxlUk2PmzA\\n 5CDDD9D8-483E-4FF8-B144-DD80F29A5BE5\\n"}]',
'title' => '翻页遍历域名列表',
'description' => '针对域名持有数量较大的用户,查询域名列表接口响应可能存在缓慢的情况,阿里云提供了翻页遍历域名列表的功能。该接口在第一次调用时,需要传入查询条件,但不要传入scrollId,此时接口会返回scrollId,并不返回数据。第二次查询开始,需要传入上一次请求获取的scrollId,并且后续查询中传入的查询条件将不会生效,需以第一次请求时的查询条件为准。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainSuffix' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'D1C9DE44-1D7F-4F66-9653-00000',
],
'SuffixList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Suffix' => [
'type' => 'array',
'items' => [
'description' => '后缀列表。',
'type' => 'string',
'example' => 'com,net,cn,name',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D1C9DE44-1D7F-4F66-9653-00000\\",\\n \\"SuffixList\\": {\\n \\"Suffix\\": [\\n \\"com,net,cn,name\\"\\n ]\\n }\\n}","errorExample":"{\\n \\"requestId\\": \\"D8E8380A-A34F-4DC2-B440-00000\\",\\n \\"suffixList\\": [\\n \\"com\\",\\n \\"sx.cn\\",\\n \\"cn\\",\\n \\"name\\"\\n ]\\n}"},{"type":"xml","example":"\\n\\n \\n com\\n net\\n cn\\n name\\n \\n D1C9DE44-1D7F-4F66-9653-00000\\n","errorExample":"\\n\\n \\n com\\n sx.cn\\n cn\\n name\\n \\n D1C9DE44-1D7F-4F66-9653-00000\\n"}]',
'title' => '查询高级搜索后缀列表',
'summary' => '调用QueryDomainSuffix高级搜索后缀列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryAdvancedDomainList' => [
'summary' => '调用QueryAdvancedDomainList高级搜索域名列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'EndExpirationDate',
'in' => 'query',
'schema' => [
'description' => '到期日期范围查询结束时间,UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'StartExpirationDate',
'in' => 'query',
'schema' => [
'description' => '到期日期范围查询开始时间,UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'ProductDomainType',
'in' => 'query',
'schema' => [
'description' => '域名类型。取值:'."\n"
.'- **New gTLD**(新顶级域名)。'."\n"
.'- **gTLD**(通用顶级域名)。'."\n"
.'- **ccTLD**(国家代码顶级域名)。'."\n"
.'- **other**(除上述类型之外的其他顶级域名)。',
'type' => 'string',
'required' => false,
'example' => 'gTLD',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '分页页码,最小值为**0**。'."\n"
.' ',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '0',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,最小值为**1**,最大值为**200**。'."\n"
.' ',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '200',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => '域名分组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'DomainNameSort',
'in' => 'query',
'schema' => [
'description' => '排序字段,根据域名字典序排序。取值:'."\n"
.'- **false**:降序。'."\n"
.'- **true**:升序。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'DomainStatus',
'in' => 'query',
'schema' => [
'description' => '域名状态。取值:'."\n"
.'- **0**:全部。'."\n"
.'- **1**:急需续费。'."\n"
.'- **2**:急需赎回。'."\n"
.'- **3**:正常。'."\n"
.'- **4**:正在转出万网。'."\n"
.'- **5**:域名持有者信息修改中。'."\n"
.'- **6**:未实名认证。'."\n"
.'- **7**:审核失败,重新实名认证。'."\n"
.'- **8**:审核中。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'EndLength',
'in' => 'query',
'schema' => [
'description' => '域名长度范围查询结束长度。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
],
],
[
'name' => 'Excluded',
'in' => 'query',
'schema' => [
'description' => '排除关键字。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ExcludedPrefix',
'in' => 'query',
'schema' => [
'description' => '开头排除关键字。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ExcludedSuffix',
'in' => 'query',
'schema' => [
'description' => '结束排除关键字。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ExpirationDateSort',
'in' => 'query',
'schema' => [
'description' => '排序字段,根据到期日排序。取值:'."\n"
.'- **false**:降序。'."\n"
.'- **true**:升序。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'Form',
'in' => 'query',
'schema' => [
'description' => '域名组成信息。'."\n"
.'- **11**:纯数字域名'."\n"
.'- **12**:纯字母域名'."\n"
.'- **13**:杂米(字母和数字组合的域名)'."\n"
.'- **14**:中文域名',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '12',
],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => [
'description' => '关键字。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'KeyWordPrefix',
'in' => 'query',
'schema' => [
'description' => '开头关键字。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'KeyWordSuffix',
'in' => 'query',
'schema' => [
'description' => '结束关键字。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ProductDomainTypeSort',
'in' => 'query',
'schema' => [
'description' => '排序字段,根据域名类型排序。取值:'."\n"
.'- **false**:降序。'."\n"
.'- **true**:升序。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegistrationDateSort',
'in' => 'query',
'schema' => [
'description' => '排序字段,根据注册日排序。取值:'."\n"
.'- **false**:降序。'."\n"
.'- **true**:升序。 '."\n"
.' ',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'StartLength',
'in' => 'query',
'schema' => [
'description' => '域名长度范围查询开始长度。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
],
],
[
'name' => 'TradeType',
'in' => 'query',
'schema' => [
'description' => '发布状态。取值:'."\n"
.'- **2**:已发布一口价。'."\n"
.'- **13**:已发布议价。'."\n"
.'- **4**:已发布竞价。'."\n"
.'- **6**:已发布带价push。'."\n"
.'- **-1**:未发布域名交易。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'Suffixs',
'in' => 'query',
'schema' => [
'description' => '查询后缀列表,以逗号“,”隔开。',
'type' => 'string',
'required' => false,
'example' => 'com.cn',
],
],
[
'name' => 'StartRegistrationDate',
'in' => 'query',
'schema' => [
'description' => '注册日期范围查询开始时间,UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndRegistrationDate',
'in' => 'query',
'schema' => [
'description' => '注册日期范围查询结束时间,UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '资源组id。',
'type' => 'string',
'required' => false,
'example' => 'rg-acfmw6bpc6n7zai',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '标签列表。',
'type' => 'array',
'items' => [
'description' => '标签列表。'."\n",
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => '数智',
],
'Value' => [
'description' => '实例的标签值。',
'type' => 'string',
'required' => false,
'example' => '废弃',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
[
'name' => 'IsPremiumDomain',
'in' => 'query',
'schema' => [
'description' => '是否为白金词域名,取值:'."\n"
."\n"
.'- **false**:否。'."\n"
.'- **true**:是。'."\n"
."\n"
.'默认值为false。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。',
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'D200000-C0B9-4CD3-B92A-9B44A000000',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalPageNum' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '275',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Domain' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'description' => '域名列表。',
'type' => 'object',
'properties' => [
'DomainAuditStatus' => [
'description' => '域名实名认证状态。取值:'."\n"
.'- **FAILED**:实名认证失败。'."\n"
.'- **SUCCEED**:实名认证成功。'."\n"
.'- **NONAUDIT**:未实名认证。'."\n"
.'- **AUDITING**:审核中。',
'type' => 'string',
'example' => 'SUCCEED',
],
'DomainGroupId' => [
'description' => '域名分组编号。',
'type' => 'string',
'example' => '-1',
],
'Remark' => [
'description' => '域名备注。',
'type' => 'string',
'example' => '备注',
],
'DomainGroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => '默认分组',
],
'ZhRegistrantOrganization' => [
'description' => '中文域名持有者。',
'type' => 'string',
'example' => 'Tom',
],
'RegistrantOrganization' => [
'description' => '域名持有者。',
'type' => 'string',
'example' => 'Tom',
],
'RegistrationDate' => [
'description' => '注册时间。'."\n",
'type' => 'string',
'example' => '2018-04-09 17:07:03',
],
'InstanceId' => [
'description' => '实例编号。',
'type' => 'string',
'example' => 'S20182000000000',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'ExpirationDateStatus' => [
'description' => '域名过期状态。取值:'."\n"
.'- **1**:域名未过期。'."\n"
.'- **2**:域名已过期。',
'type' => 'string',
'example' => '1',
],
'ExpirationDate' => [
'description' => '域名到期日。',
'type' => 'string',
'example' => '2019-04-09 17:07:03',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Dns' => [
'description' => 'dns列表。',
'type' => 'array',
'items' => [
'description' => 'DNS列表。',
'type' => 'string',
'example' => '["dns15.hichina.com", "dns16.hichina.com"]',
],
],
],
],
'Email' => [
'description' => '邮箱。',
'type' => 'string',
'example' => 'username@example.com',
],
'RegistrantType' => [
'description' => '域名注册类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。',
'type' => 'string',
'example' => '1',
],
'ExpirationDateLong' => [
'description' => '域名到期日,UTC时间1970年1月1日0点距离域名到期日的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1554800823000',
],
'ExpirationCurrDateDiff' => [
'description' => '到期日和当前日期差。',
'type' => 'integer',
'format' => 'int32',
'example' => '356',
],
'Premium' => [
'description' => '是否是溢价词。',
'type' => 'boolean',
'example' => 'false',
],
'RegistrationDateLong' => [
'description' => '注册时间,UTC时间1970年1月1日0点距离注册时间的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1523264823000',
],
'ProductId' => [
'description' => '产品ID。',
'type' => 'string',
'example' => '2a',
],
'DomainStatus' => [
'description' => '域名状态。取值:'."\n"
.'- **1**:急需续费。'."\n"
.'- **2**:急需赎回。'."\n"
.'- **3**:正常。'."\n"
.'- **4**:转出中。'."\n"
.'- **5**:域名持有者信息修改中。'."\n"
.'- **6**:未实名认证。'."\n"
.'- **7**:实名认证失败。'."\n"
.'- **8**:实名认证审核中。',
'type' => 'string',
'example' => '5',
],
'DomainType' => [
'description' => '域名类型。取值:'."\n"
.'- **New gTLD**。'."\n"
.'- **gTLD**。'."\n"
.'- **ccTLD**。',
'type' => 'string',
'example' => 'gTLD',
],
'ResourceGroupId' => [
'description' => '资源组 ID。',
'type' => 'string',
'example' => 'rg-aek2yyciz557g3q',
],
'Tag' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => '备注',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => '标签1',
],
],
],
],
],
],
],
],
],
],
],
'TotalItemNum' => [
'description' => '记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '549',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 1,\\n \\"RequestId\\": \\"D200000-C0B9-4CD3-B92A-9B44A000000\\",\\n \\"PageSize\\": 2,\\n \\"TotalPageNum\\": 275,\\n \\"Data\\": {\\n \\"Domain\\": [\\n {\\n \\"DomainAuditStatus\\": \\"SUCCEED\\",\\n \\"DomainGroupId\\": \\"-1\\",\\n \\"Remark\\": \\"备注\\",\\n \\"DomainGroupName\\": \\"默认分组\\",\\n \\"ZhRegistrantOrganization\\": \\"Tom\\",\\n \\"RegistrantOrganization\\": \\"Tom\\",\\n \\"RegistrationDate\\": \\"2018-04-09 17:07:03\\",\\n \\"InstanceId\\": \\"S20182000000000\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"ExpirationDateStatus\\": \\"1\\",\\n \\"ExpirationDate\\": \\"2019-04-09 17:07:03\\",\\n \\"DnsList\\": {\\n \\"Dns\\": [\\n \\"[\\\\\\"dns15.hichina.com\\\\\\", \\\\\\"dns16.hichina.com\\\\\\"]\\"\\n ]\\n },\\n \\"Email\\": \\"username@example.com\\",\\n \\"RegistrantType\\": \\"1\\",\\n \\"ExpirationDateLong\\": 1554800823000,\\n \\"ExpirationCurrDateDiff\\": 356,\\n \\"Premium\\": false,\\n \\"RegistrationDateLong\\": 1523264823000,\\n \\"ProductId\\": \\"2a\\",\\n \\"DomainStatus\\": \\"5\\",\\n \\"DomainType\\": \\"gTLD\\",\\n \\"ResourceGroupId\\": \\"rg-aek2yyciz557g3q\\",\\n \\"Tag\\": {\\n \\"Tag\\": [\\n {\\n \\"Key\\": \\"备注\\",\\n \\"Value\\": \\"标签1\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"TotalItemNum\\": 549,\\n \\"NextPage\\": true\\n}","errorExample":""},{"type":"xml","example":"false\\n1\\n2\\nD200000-C0B9-4CD3-B92A-9B44A000000\\n275\\n\\n \\n 1\\n username@example.com\\n 356\\n 1523264823000\\n 2018-04-09 17:07:03\\n S20182000000000\\n example.com\\n -1\\n false\\n 2a\\n SUCCEED\\n 备注\\n 1554800823000\\n 1\\n gTLD\\n 默认分组\\n 2019-04-09 17:07:03\\n Tom\\n Tom\\n 5\\n \\n [\\"dns15.hichina.com\\", \\"dns16.hichina.com\\"]\\n \\n \\n\\n549\\ntrue","errorExample":"\\n\\n\\n \\n \\n 1523264823000\\n S20182000000000\\n 5\\n 1\\n SUCCEED\\n 1554800823000\\n false\\n 2a\\n 2019-04-09 17:07:03\\n -1\\n 1\\n 2018-04-09 17:07:03\\n 默认分组\\n test1.com\\n \\n 356\\n \\n \\n \\n 1523263508000\\n S20182000000001\\n 1\\n 1\\n SUCCEED\\n 1554799508000\\n false\\n 2a\\n 2019-04-09 16:45:08\\n -1\\n 1\\n 2018-04-09 16:45:08\\n 默认分组\\n test2.com\\n \\n 356\\n \\n \\n \\n 549\\n 2\\n 1\\n 00000-B054-4444-8F48-000000\\n false\\n 275\\n true\\n"}]',
'title' => '高级搜索域名列表',
'description' => '搜索您当前阿里云账号下满足特定条件的域名。最多显示**5000**条,达到**5000**条请缩小搜索范围。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'LookupTmchNotice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClaimKey',
'in' => 'query',
'schema' => [
'description' => '域名商标词key,通过[CheckDomainSunriseClaim](https://help.aliyun.com/document_detail/97210.htm?spm=a2c4g.11186623.0.0.4aec615fTVPYjt)接口获取。',
'type' => 'string',
'required' => true,
'example' => '2017092100/8/2/1/kDfu9htHGEx_y-LJ3XSlKMZ70000020001',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Claims' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Claim' => [
'description' => '商标信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'GoodsAndServices' => [
'description' => '商标产品及服务信息。',
'type' => 'string',
'example' => 'Class 9: Calculators; bags, coverings,containers, carriers and holders for mobile phones, personal handheld computers and notebooks; headphones; speakers; blank storage media;batteries. Class 16: Paper',
],
'Contacts' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Contact' => [
'description' => '商标联系人列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => [
'description' => '类型。',
'type' => 'string',
'example' => 'agent',
],
'Voice' => [
'description' => '电话。',
'type' => 'string',
'example' => '1390000****',
],
'Email' => [
'description' => '电子邮件。',
'type' => 'string',
'example' => 'username@example.com',
],
'Fax' => [
'description' => '传真。',
'type' => 'string',
'example' => '4472335**8',
],
'Addr' => [
'description' => '地址。',
'type' => 'object',
'properties' => [
'Cc' => [
'description' => '国家。',
'type' => 'string',
'example' => 'NZ',
],
'Sp' => [
'description' => '省。',
'type' => 'string',
'example' => 'Auckland',
],
'Pc' => [
'description' => '邮编。',
'type' => 'string',
'example' => '1010',
],
'City' => [
'description' => '市。',
'type' => 'string',
'example' => 'Auckland',
],
'Street' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Street' => [
'type' => 'array',
'items' => [
'description' => '街道。',
'type' => 'string',
'example' => 'Level 5 131 Queen Street',
],
],
],
],
],
],
'Org' => [
'description' => '组织。',
'type' => 'string',
'example' => 'Tom',
],
'Name' => [
'description' => '姓名。',
'type' => 'string',
'example' => 'Tom',
],
],
],
],
],
],
'MarkName' => [
'description' => '商标名称。',
'type' => 'string',
'example' => 'POTED',
],
'ClassDescs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ClassDesc' => [
'description' => '类型描述。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClassNum' => [
'description' => '类型编号。',
'type' => 'integer',
'format' => 'int32',
'example' => '18',
],
'Desc' => [
'description' => '描述。',
'type' => 'string',
'example' => 'New Zealand',
],
],
],
],
],
],
'Holders' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Holder' => [
'description' => '商标持有者信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Entitlement' => [
'description' => '持有者名称。',
'type' => 'string',
'example' => 'owner',
],
'Addr' => [
'description' => '地址。',
'type' => 'object',
'properties' => [
'Cc' => [
'description' => '国家。',
'type' => 'string',
'example' => 'NZ',
],
'Sp' => [
'description' => '省。',
'type' => 'string',
'example' => 'Wellington',
],
'Pc' => [
'description' => '邮编。',
'type' => 'string',
'example' => '6011',
],
'City' => [
'description' => '市。',
'type' => 'string',
'example' => 'Wellington',
],
'Street' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Street' => [
'type' => 'array',
'items' => [
'description' => '街道。',
'type' => 'string',
'example' => 'Level 5 131 Queen Street',
],
],
],
],
],
],
'Org' => [
'description' => '组织。',
'type' => 'string',
'example' => 'Whitcoulls 2011 Limited',
],
],
],
],
],
],
'JurDesc' => [
'description' => '法律信息。',
'type' => 'object',
'properties' => [
'JurCC' => [
'description' => '所在地。',
'type' => 'string',
'example' => 'NZ',
],
'Desc' => [
'description' => '描述。',
'type' => 'string',
'example' => 'New Zealand',
],
],
],
],
],
],
],
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '01C10C8E-0468-468C-BCD9-E709BDD0AE8F',
],
'Label' => [
'description' => '商标标签。',
'type' => 'string',
'example' => 'noted',
],
'Id' => [
'description' => 'tmch的通知ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '586608000000',
],
'NotBefore' => [
'description' => '商标通知开始时间。',
'type' => 'string',
'example' => '2018-10-13T00:00:00.0Z',
],
'NotAfter' => [
'description' => '商标通知结束时间。',
'type' => 'string',
'example' => '2018-10-15T00:00:00.0Z',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Claims\\": {\\n \\"Claim\\": [\\n {\\n \\"GoodsAndServices\\": \\"Class 9: Calculators; bags, coverings,containers, carriers and holders for mobile phones, personal handheld computers and notebooks; headphones; speakers; blank storage media;batteries. Class 16: Paper\\",\\n \\"Contacts\\": {\\n \\"Contact\\": [\\n {\\n \\"Type\\": \\"agent\\",\\n \\"Voice\\": \\"1390000****\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"Fax\\": \\"4472335**8\\",\\n \\"Addr\\": {\\n \\"Cc\\": \\"NZ\\",\\n \\"Sp\\": \\"Auckland\\",\\n \\"Pc\\": \\"1010\\",\\n \\"City\\": \\"Auckland\\",\\n \\"Street\\": {\\n \\"Street\\": [\\n \\"Level 5 131 Queen Street\\"\\n ]\\n }\\n },\\n \\"Org\\": \\"Tom\\",\\n \\"Name\\": \\"Tom\\"\\n }\\n ]\\n },\\n \\"MarkName\\": \\"POTED\\",\\n \\"ClassDescs\\": {\\n \\"ClassDesc\\": [\\n {\\n \\"ClassNum\\": 18,\\n \\"Desc\\": \\"New Zealand\\"\\n }\\n ]\\n },\\n \\"Holders\\": {\\n \\"Holder\\": [\\n {\\n \\"Entitlement\\": \\"owner\\",\\n \\"Addr\\": {\\n \\"Cc\\": \\"NZ\\",\\n \\"Sp\\": \\"Wellington\\",\\n \\"Pc\\": \\"6011\\",\\n \\"City\\": \\"Wellington\\",\\n \\"Street\\": {\\n \\"Street\\": [\\n \\"Level 5 131 Queen Street\\"\\n ]\\n }\\n },\\n \\"Org\\": \\"Whitcoulls 2011 Limited\\"\\n }\\n ]\\n },\\n \\"JurDesc\\": {\\n \\"JurCC\\": \\"NZ\\",\\n \\"Desc\\": \\"New Zealand\\"\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"01C10C8E-0468-468C-BCD9-E709BDD0AE8F\\",\\n \\"Label\\": \\"noted\\",\\n \\"Id\\": 586608000000,\\n \\"NotBefore\\": \\"2018-10-13T00:00:00.0Z\\",\\n \\"NotAfter\\": \\"2018-10-15T00:00:00.0Z\\"\\n}","errorExample":"{\\n\\"Claims\\":{\\n \\"Claim\\":[\\n {\\n \\"GoodsAndServices\\":\\"Class 9: Calculators; bags, coverings, containers, carriers and holders for mobile phones\\",\\n \\"Contacts\\":{\\n \\"Contact\\":[\\n {\\n \\"Name\\":\\"AJ Park\\",\\n \\"Email\\":\\"dns@ajpark.com\\",\\n \\"Voice\\":\\"+64.44738278\\",\\n \\"Fax\\":\\"+64.44723358\\",\\n \\"Org\\":\\"AJ Park \\",\\n \\"Addr\\":{\\n \\"Street\\":{\\n \\"Street\\":[\\n \\"Level 22, State Insurance Tower\\",\\n \\"1 Willis St\\",\\n \\"Wellington \\"\\n ]\\n },\\n \\"Pc\\":\\"6011\\",\\n \\"Cc\\":\\"NZ\\",\\n \\"City\\":\\"Wellington\\"\\n }\\n }\\n ]\\n },\\n \\"Holders\\":{\\n \\"Holder\\":[\\n {\\n \\"Org\\":\\"Whitcoulls 2011 Limited\\",\\n \\"Addr\\":{\\n \\"Street\\":{\\n \\"Street\\":[\\n \\"Level 5 131 Queen Street \\"\\n ]\\n },\\n \\"Pc\\":\\"1010\\",\\n \\"Cc\\":\\"NZ\\",\\n \\"City\\":\\"Auckland\\"\\n },\\n \\"Entitlement\\":\\"owner\\"\\n }\\n ]\\n },\\n \\"JurDesc\\":{\\n \\"JurCC\\":\\"NZ\\",\\n \\"Desc\\":\\"New Zealand\\"\\n },\\n \\"ClassDescs\\":{\\n \\"ClassDesc\\":[\\n {\\n \\"ClassNum\\":18,\\n \\"Desc\\":\\"Leather and imitations of leather, and goods made of \\"\\n },\\n {\\n \\"ClassNum\\":35,\\n \\"Desc\\":\\"Advertising; business management; business administration; office functions. \\"\\n }\\n ]\\n },\\n \\"MarkName\\":\\"NOTED\\"\\n }\\n ]\\n},\\n\\"NotBefore\\":\\"2018-10-13T00:00:00.0Z\\",\\n\\"NotAfter\\":\\"2018-10-23T00:00:00.0Z\\",\\n\\"RequestId\\":\\"01C10C8E-0468-468C-BCD9-E709BDD0AE8F\\",\\n\\"Id\\":\\"f58a66080000000000205821776\\",\\n\\"Label\\":\\"noted\\""},{"type":"xml","example":"\\n f58a66080000000000205821776\\n 2018-10-13T00:00:00.0Z\\n 2018-10-15T00:00:00.0Z\\n \\n \\n \\n POTED\\n \\n Whitcoulls 2011 Limited\\n \\n Level 5 131 Queen Street \\n Auckland\\n 1010\\n NZ\\n \\n \\n \\n \\n Tom\\n Tom\\n \\n Level 22, State Insurance Tower\\n 1 Willis St\\n Wellington \\n Wellington\\n 6011\\n NZ\\n \\n 1390000****\\n 4472335**8\\n username@example.com\\n \\n \\n Leather and imitations\\n of leather, and goods made of these materials and not included in\\n other classes; animal skins, hides; trunks and travelling bags;\\n umbrellas and parasols; walking sticks; whips, harness and saddlery.\\n \\n Advertising; business\\n management; business administration; office functions.\\n \\n Class 9: Calculators; bags, coverings,\\n containers, carriers and holders for mobile phones, personal handheld\\n computers and notebooks; headphones; speakers; blank storage media;\\n batteries. Class 16: Paper\\n \\n \\n \\n","errorExample":"\\n f58a66080000000000205821776\\n 2018-10-13T00:00:00.0Z\\n 2018-10-15T00:00:00.0Z\\n \\n \\n \\n POTED\\n \\n Whitcoulls 2011 Limited\\n \\n Level 5 131 Queen Street \\n Auckland\\n 1010\\n NZ\\n \\n \\n \\n \\n AJ Park\\n AJ Park \\n \\n Level 22, State Insurance Tower\\n 1 Willis St\\n Wellington \\n Wellington\\n 6011\\n NZ\\n \\n +64.44738278\\n +64.44723358\\n dns@ajpark.com\\n \\n \\n Leather and imitations\\n of leather, and goods made of these materials and not included in\\n other classes; animal skins, hides; trunks and travelling bags;\\n umbrellas and parasols; walking sticks; whips, harness and saddlery.\\n \\n Advertising; business\\n management; business administration; office functions.\\n \\n Class 9: Calculators; bags, coverings,\\n containers, carriers and holders for mobile phones, personal handheld\\n computers and notebooks; headphones; speakers; blank storage media;\\n batteries. Class 16: Paper\\n \\n \\n \\n"}]',
'title' => '查询tmch(商标词)信息',
'summary' => '调用LookupTmchNotice根据传入商标词key查询tmch(商标词)信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CheckDomainSunriseClaim' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '要查询的域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ClaimKey' => [
'description' => 'TMDB库提供的商标词key。',
'type' => 'string',
'example' => '2017092100/8/2/1/kDfu9htHGEx_y-LJ3XSlKMZ70000020001',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1',
],
'Result' => [
'description' => '结果。取值:'."\n"
.'- **0**:不是商标词或不处于claim域名生命周期。'."\n"
.'- **1**:sunrise域名生命周期。'."\n"
.'- **2**:claim域名生命周期。'."\n"
.' ',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\",\\n \\"ClaimKey\\": \\"2017092100/8/2/1/kDfu9htHGEx_y-LJ3XSlKMZ70000020001\\",\\n \\"Result\\": 1\\n}","errorExample":"{\\n \\"RequestId\\": \\"BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\",\\n \\"Result\\": 2,\\n \\"ClaimKey\\": \\"2017092100/8/2/1/kDfu9htHGEx_y-LJ3XSlKMZ70000020001\\"\\n}"},{"type":"xml","example":"\\n BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\n 1\\n 2017092100/8/2/1/kDfu9htHGEx_y-LJ3XSlKMZ70000020001\\n","errorExample":"\\n BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1\\n 1\\n 2017092100/8/2/1/kDfu9htHGEx_y-LJ3XSlKMZ70000020001\\n"}]',
'title' => '根据传入域名查询商标词 Key',
'summary' => '根据传入域名查询商标词key。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryArtExtension' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test.art',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ObjectType' => [
'description' => '艺术品分类。',
'type' => 'string',
'example' => 'The embroidery',
],
'MaterialsAndTechniques' => [
'description' => '材质与工艺。',
'type' => 'string',
'example' => 'silk',
],
'InscriptionsAndMarkings' => [
'description' => '题词和标识。',
'type' => 'string',
'example' => 'realism',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '814B2AF0-ED6F-4C13-B41C-8AC0B1023583',
],
'Reference' => [
'description' => '参考。',
'type' => 'string',
'example' => 'drawings',
],
'DateOrPeriod' => [
'description' => '创作时间。',
'type' => 'string',
'example' => '2019-10-01',
],
'Dimensions' => [
'description' => '尺寸。',
'type' => 'string',
'example' => '20 cm',
],
'Title' => [
'description' => '名称。',
'type' => 'string',
'example' => 'Peace and friendship',
],
'Features' => [
'description' => '艺术特征。',
'type' => 'string',
'example' => 'iconicity',
],
'Subject' => [
'description' => '艺术主题。',
'type' => 'string',
'example' => 'peace',
],
'Maker' => [
'description' => '艺术家、创作者。'."\n",
'type' => 'string',
'example' => 'zhang san',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ObjectType\\": \\"The embroidery\\",\\n \\"RequestId\\": \\"814B2AF0-ED6F-4C13-B41C-8AC0B1023583\\",\\n \\"Subject\\": \\"peace\\",\\n \\"Dimensions\\": \\"20 cm\\",\\n \\"DateOrPeriod\\": \\"2019-10-01\\",\\n \\"Title\\": \\"Peace and friendship\\",\\n \\"MaterialsAndTechniques\\": \\"silk\\",\\n \\"Reference\\": \\"drawings\\",\\n \\"Maker\\": \\"zhang san\\",\\n \\"InscriptionsAndMarkings\\": \\"realism\\",\\n \\"Features\\": \\"iconicity\\"\\n}","errorExample":"{\\n \\"DateOrPeriod\\":\\"2019-10-01\\",\\n \\"Dimensions\\":\\"dimensions\\",\\n \\"Features\\":\\"features\\",\\n \\"InscriptionsAndMarkings\\":\\"markings\\",\\n \\"Maker\\":\\"maker\\",\\n \\"MaterialsAndTechniques\\":\\"materials\\",\\n \\"ObjectType\\":\\"objectType\\",\\n \\"Reference\\":\\"reference\\",\\n \\"RequestId\\":\\"814B2AF0-ED6F-4C13-B41C-8AC0B1023583\\",\\n \\"Subject\\":\\"subject\\",\\n \\"Title\\":\\"title\\"\\n}"},{"type":"xml","example":"\\n2019-10-01\\n20 cm\\niconicity\\nrealism\\nzhang san\\nsilk\\nThe embroidery\\ndrawings\\n814B2AF0-ED6F-4C13-B41C-8AC0B1023583\\npeace\\nPeace and friendship\\n","errorExample":"\\n title \\n subject\\n reference\\n objectType\\n materials\\n maker\\n markings\\n features\\n dimensions\\n 2019-10-01\\n 5FF5CB45-F34E-406C-8760-C51972EEC315\\n"}]',
'title' => '查询Art扩展信息',
'summary' => '调用QueryArtExtension查询Art扩展信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForCreatingDnsHost' => [
'summary' => '调用SaveSingleTaskForCreatingDnsHost提交单个创建dnshost任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号,可通过查询域名列表接口[QueryDomainList](~~67712~~)获得。'."\n"
.' ',
'type' => 'string',
'required' => true,
'example' => 'S1234567890',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DnsName',
'in' => 'query',
'schema' => [
'description' => 'DNS名称。',
'type' => 'string',
'required' => true,
'example' => 'dns1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Ip',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'IP地址列表,最多可填写13个,多个IP时使用**list**方式传入。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'string',
'required' => false,
'example' => '218.xx.xx.236',
],
'required' => true,
'example' => '218.xx.xx.236',
'maxItems' => 13,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0F1B3547-BE50-4206-8F78-9540FFB85BC1',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e9b8e8b4-7334-4548-9cec-c30b6891f292',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F1B3547-BE50-4206-8F78-9540FFB85BC1\\",\\n \\"TaskNo\\": \\"e9b8e8b4-7334-4548-9cec-c30b6891f292\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"0F1B3547-BE50-4206-8F78-9540FFB85BC1\\",\\n \\"taskNo\\": \\"e9b8e8b4-7334-4548-9cec-c30b6891f292\\"\\n}"},{"type":"xml","example":"\\ne9b8e8b4-7334-4548-9cec-c30b6891f292\\n0F1B3547-BE50-4206-8F78-9540FFB85BC1\\n","errorExample":"\\n\\ne9b8e8b4-7334-4548-9cec-c30b6891f292\\n0F1B3547-BE50-4206-8F78-9540FFB85BC1\\n"}]',
'title' => '提交单个创建dnshost任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForAddingDSRecord' => [
'summary' => '调用SaveSingleTaskForAddingDSRecord提交创建DS记录任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'KeyTag',
'in' => 'query',
'schema' => [
'description' => '密钥标签,用于标识DNSSEC记录,为小于65536的整数值。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '加密算法编号,详见[Domain Name System Security (DNSSEC) Algorithm Numbers](https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml)。取值:'."\n"
.'- **1**:RSA/MD5。'."\n"
.'- **2**:Diffie-Hellman。'."\n"
.'- **3**:DSA/SHA-1。'."\n"
.'- **5**:RSA/SHA-1。'."\n"
.'- **6**:DSA-NSEC3-SHA1。'."\n"
.'- **7**:RSASHA1-NSEC3-SHA1。'."\n"
.'- **8**:RSA/SHA-256。'."\n"
.'- **10**:RSA/SHA-512。'."\n"
.'- **12**:GOST R 34.10-2001。'."\n"
.'- **13**:ECDSA Curve P-256 with SHA-256。'."\n"
.'- **14**:ECDSA Curve P-384 with SHA-384。'."\n"
.'- **15**:Ed2551916 Ed448。'."\n"
.'- **252**:Reserved for Indirect Keys。'."\n"
.'- **253**:private algorithm。'."\n"
.'- **254**:private algorithm OID。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'DigestType',
'in' => 'query',
'schema' => [
'description' => '摘要算法类型,详见[Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms](https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml)。取值:'."\n"
.'- **1**:SHA-1;'."\n"
.'- **2**:SHA-256;'."\n"
.'- **3**:GOST R 34.11-94;'."\n"
.'- **4**:SHA-384。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'Digest',
'in' => 'query',
'schema' => [
'description' => '摘要。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e893148f-6343-4ae1-9eba-6e2a4116e142',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\": \\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\":\\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}"},{"type":"xml","example":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n","errorExample":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n"}]',
'title' => '提交创建DS记录任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口查询。'."\n"
.' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForDeletingDnsHost' => [
'summary' => '调用SaveSingleTaskForDeletingDnsHost提交删除DNSHost任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例ID。',
'type' => 'string',
'required' => true,
'example' => 'S2019270W570xxxx',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DnsName',
'in' => 'query',
'schema' => [
'description' => 'DNS名称。',
'type' => 'string',
'required' => true,
'example' => 'dns1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '8fc97e44-837a-447d-ac61-ea28d2fe8a38',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '8fc97e44-837a-447d-ac61-ea28d2fexxxx',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8fc97e44-837a-447d-ac61-ea28d2fe8a38\\",\\n \\"TaskNo\\": \\"8fc97e44-837a-447d-ac61-ea28d2fexxxx\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8fc97e44-837a-447d-ac61-ea28d2fexxxx\\n B0AC8092-3FE3-4EBC-9620-EC4BB1FB75D3\\n","errorExample":""}]',
'title' => '提交删除DNSHost任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForDeletingDSRecord' => [
'summary' => '调用SaveSingleTaskForDeletingDSRecord提交删除DS记录任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'KeyTag',
'in' => 'query',
'schema' => [
'description' => '关键标签,用于标识DNSSEC记录,为小于65536的整数值。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e893148f-6343-4ae1-9eba-6e2a4116e142',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\": \\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\":\\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}"},{"type":"xml","example":"\\n 612db86b-4d8e-44ab-8d54-8d3fb3c0c582\\n 2D347ECF-6D8E-4202-8236-692362D8D004\\n","errorExample":"\\n 612db86b-4d8e-44ab-8d54-8d3fb3c0c582\\n 2D347ECF-6D8E-4202-8236-692362D8D004\\n"}]',
'title' => '提交删除DS记录任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForSynchronizingDnsHost' => [
'summary' => '调用SaveSingleTaskForSynchronizingDnsHost提交同步DNS host任务。用来处理DNS host缺失、不一致等情况。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号,可通过查询域名列表接口[QueryDomainList](~~67712~~)获得。',
'type' => 'string',
'required' => true,
'example' => 'ST2017120814571100001303',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0F1B3547-BE50-4206-8F78-9540FFB85BC1',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e9b8e8b4-7334-4548-9cec-c30b6891f292',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F1B3547-BE50-4206-8F78-9540FFB85BC1\\",\\n \\"TaskNo\\": \\"e9b8e8b4-7334-4548-9cec-c30b6891f292\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"0F1B3547-BE50-4206-8F78-9540FFB85BC1\\",\\n \\"taskNo\\": \\"e9b8e8b4-7334-4548-9cec-c30b6891f292\\"\\n}"},{"type":"xml","example":"\\n\\ne9b8e8b4-7334-4548-9cec-c30b6891f292\\n0F1B3547-BE50-4206-8F78-9540FFB85BC1\\n","errorExample":"\\n\\ne9b8e8b4-7334-4548-9cec-c30b6891f292\\n0F1B3547-BE50-4206-8F78-9540FFB85BC1\\n"}]',
'title' => '提交同步DNS host任务',
'description' => '任务执行结果请通过[查询任务详情列表](~~67710~~)接口来查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForSynchronizingDSRecord' => [
'summary' => '调用SaveSingleTaskForSynchronizingDSRecord提交同步DS记录任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e893148f-6343-4ae1-9eba-6e2a4116e142',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\": \\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\":\\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}"},{"type":"xml","example":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n","errorExample":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n"}]',
'title' => '提交同步DS记录任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForModifyingDnsHost' => [
'summary' => '调用SaveSingleTaskForModifyingDnsHost提交修改dnshost任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号,可通过查询域名列表接口(QueryDomainList)获得。'."\n"
.' ',
'type' => 'string',
'required' => true,
'example' => 'S123456789',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DnsName',
'in' => 'query',
'schema' => [
'description' => 'DNS名称。',
'type' => 'string',
'required' => true,
'example' => 'dns1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Ip',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'IP地址列表。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'string',
'required' => false,
'example' => '218.xx.xx.236',
],
'required' => true,
'example' => '218.xx.xx.236',
'maxItems' => 13,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0F1B3547-BE50-4206-8F78-9540FFB85BC1',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e9b8e8b4-7334-4548-9cec-c30b6891f292',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0F1B3547-BE50-4206-8F78-9540FFB85BC1\\",\\n \\"TaskNo\\": \\"e9b8e8b4-7334-4548-9cec-c30b6891f292\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"0F1B3547-BE50-4206-8F78-9540FFB85BC1\\",\\n \\"taskNo\\": \\"e9b8e8b4-7334-4548-9cec-c30b6891f292\\"\\n}"},{"type":"xml","example":"\\n0F1B3547-BE50-4206-8F78-9540FFB85BC1\\ne9b8e8b4-7334-4548-9cec-c30b6891f292\\n","errorExample":"\\n\\ne9b8e8b4-7334-4548-9cec-c30b6891f292\\n0F1B3547-BE50-4206-8F78-9540FFB85BC1\\n"}]',
'title' => '提交修改dnshost任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForModifyingDSRecord' => [
'summary' => '调用SaveSingleTaskForModifyingDSRecord提交修改DS记录任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'KeyTag',
'in' => 'query',
'schema' => [
'description' => '关键标签,用于标识DNSSEC记录,为小于65536的整数值。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '加密算法编号,详见[Domain Name System Security (DNSSEC) Algorithm Numbers](https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml)。取值:'."\n"
.'- **1** RSA/MD5;'."\n"
.'- **2** Diffie-Hellman;'."\n"
.'- **3** DSA/SHA-1;'."\n"
.'- **5** RSA/SHA-1;'."\n"
.'- **6**:DSA-NSEC3-SHA1;'."\n"
.'- **7**:RSASHA1-NSEC3-SHA1;'."\n"
.'- **8**:RSA/SHA-256;'."\n"
.'- **10**:RSA/SHA-512;'."\n"
.'- **12**:GOST R 34.10-2001;'."\n"
.'- **13**:ECDSA Curve P-256 with SHA-256;'."\n"
.'- **14**:ECDSA Curve P-384 with SHA-384;'."\n"
.'- **15**:Ed2551916 Ed448;'."\n"
.'- **252**:Reserved for Indirect Keys;'."\n"
.'- **253**:private algorithm;'."\n"
.'- **254**:private algorithm OID。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'DigestType',
'in' => 'query',
'schema' => [
'description' => '摘要算法类型,详见[Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms](https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml)。取值:'."\n"
.'- **1**:SHA-1;'."\n"
.'- **2**:SHA-256;'."\n"
.'- **3**:GOST R 34.11-94;'."\n"
.'- **4**:SHA-384。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '2',
],
],
[
'name' => 'Digest',
'in' => 'query',
'schema' => [
'description' => '摘要值。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e893148f-6343-4ae1-9eba-6e2a4116e142',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\": \\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\":\\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}"},{"type":"xml","example":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n","errorExample":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n"}]',
'title' => '提交修改DS记录任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForModifyingDomainDns' => [
'summary' => '调用SaveBatchTaskForModifyingDomainDns提交批量修改域名DNS任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'AliyunDns',
'in' => 'query',
'schema' => [
'description' => '是否修改为阿里云DNS。取值:'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名。',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
'example' => 'example.cn',
],
'required' => true,
'example' => 'example.com',
'maxItems' => 1000,
],
],
[
'name' => 'DomainNameServer',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'DNS列表,**AliyunDns**值为**false**时此项必填。',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
'example' => 'ns1.aliyun.com',
],
'required' => false,
'example' => 'ns1.test.com',
'maxItems' => 13,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '6A862A8A-E7AB-4C4E-8946-A74122D9CC4B',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '35fb2fb7-d4d6-4478-9408-22cb63696b86',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6A862A8A-E7AB-4C4E-8946-A74122D9CC4B\\",\\n \\"TaskNo\\": \\"35fb2fb7-d4d6-4478-9408-22cb63696b86\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"689C17B3-6AE0-45FB-8E41-4491A02C9999\\",\\n \\"taskNo\\": \\"fce12087-6c9f-4dcd-92df-d3829b7f19bc\\"\\n}"},{"type":"xml","example":"\\n\\n35fb2fb7-d4d6-4478-9408-22cb63696b86\\n6A862A8A-E7AB-4C4E-8946-A74122D9CC4B","errorExample":"\\n\\n35fb2fb7-d4d6-4478-9408-22cb63696b86\\n6A862A8A-E7AB-4C4E-8946-A74122D9CC4B"}]',
'title' => '提交批量修改域名DNS任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDnsHost' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号,可通过查询域名列表接口QueryDomainList获得。',
'type' => 'string',
'required' => true,
'example' => 'ST2017120814571100001303',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '18A313DD-3AF3-40AA-84F9-56BA45DC511F',
],
'DnsHostList' => [
'description' => 'DNS host信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DnsName' => [
'description' => 'DNS 名称。',
'type' => 'string',
'example' => 'ns3',
],
'IpList' => [
'type' => 'array',
'items' => [
'description' => 'IP地址列表。',
'type' => 'string',
'example' => '185.27.XX.XX, 218.83.XX.XX',
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"18A313DD-3AF3-40AA-84F9-56BA45DC511F\\",\\n \\"DnsHostList\\": [\\n {\\n \\"DnsName\\": \\"ns3\\",\\n \\"IpList\\": [\\n \\"185.27.XX.XX, 218.83.XX.XX\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n \\n ns3\\n 185.27.XX.XX\\n 218.83.XX.XX\\n \\n 6A973B69-7B5F-4959-AA89-ED4010541D20\\n","errorExample":""}]',
'title' => '查询域名DNS Host',
'summary' => '调用QueryDnsHost查询域名DNS host。',
'requestParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDSRecord' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '814B2AF0-ED6F-4C13-B41C-8AC0B1023583',
],
'DSRecordList' => [
'description' => 'DS记录列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DigestType' => [
'description' => '摘要算法类型,详见[Delegation Signer (DS) Resource Record (RR) Type Digest Algorithms](https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml)。取值:'."\n"
.' - **1**:SHA-1;'."\n"
.' - **2**:SHA-256;'."\n"
.' - **3**:GOST R 34.11-94;'."\n"
.' - **4**:SHA-384。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Digest' => [
'description' => '摘要值。',
'type' => 'string',
'example' => 'f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598',
],
'Algorithm' => [
'description' => '加密算法编号,详见[Domain Name System Security (DNSSEC) Algorithm Numbers](https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml)。取值:'."\n"
.' - **1**:RSA/MD5;'."\n"
.' - **2**:Diffie-Hellman;'."\n"
.' - **3**:DSA/SHA-1;'."\n"
.' - **5**:RSA/SHA-1;'."\n"
.' - **6**:DSA-NSEC3-SHA1;'."\n"
.' - **7**:RSASHA1-NSEC3-SHA1;'."\n"
.' - **8**:RSA/SHA-256;'."\n"
.' - **10**:RSA/SHA-512;'."\n"
.' - **12**:GOST R 34.10-2001;'."\n"
.' - **13**:ECDSA Curve P-256 with SHA-256;'."\n"
.' - **14**:ECDSA Curve P-384 with SHA-384;'."\n"
.' - **15**:Ed25519;'."\n"
.' - **16**:Ed448;'."\n"
.' - **252**:Reserved for Indirect Keys;'."\n"
.' - **253**:private algorithm;'."\n"
.' - **254**:private algorithm OID。'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'KeyTag' => [
'description' => '关键标签,用于标识DNSSEC记录,为小于65536的整数值。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"814B2AF0-ED6F-4C13-B41C-8AC0B1023583\\",\\n \\"DSRecordList\\": [\\n {\\n \\"DigestType\\": 2,\\n \\"Digest\\": \\"f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598\\",\\n \\"Algorithm\\": 1,\\n \\"KeyTag\\": 1\\n }\\n ]\\n}","errorExample":"{\\n \\"DSRecordList\\":[\\n {\\n \\"Algorithm\\":2,\\n \\"Digest\\":\\"f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598\\",\\n \\"DigestType\\":2,\\n \\"KeyTag\\":11\\n },\\n {\\n \\"Algorithm\\":2,\\n \\"Digest\\":\\"a55f53655743cf37f8dd69256f9f8780fd72eef30551fe24e747956221d42095\\",\\n \\"DigestType\\":2,\\n \\"KeyTag\\":1\\n }\\n ],\\n \\"RequestId\\":\\"814B2AF0-ED6F-4C13-B41C-8AC0B1023583\\"\\n}"},{"type":"xml","example":"\\n \\n \\n f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598\\n 2\\n 2\\n 11\\n \\n \\n a55f53655743cf37f8dd69256f9f8780fd72eef30551fe24e747956221d42095\\n 2\\n 2\\n 1\\n \\n \\n 5FF5CB45-F34E-406C-8760-C51972EEC315\\n","errorExample":"\\n \\n \\n f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598\\n 2\\n 2\\n 11\\n \\n \\n a55f53655743cf37f8dd69256f9f8780fd72eef30551fe24e747956221d42095\\n 2\\n 2\\n 1\\n \\n \\n 5FF5CB45-F34E-406C-8760-C51972EEC315\\n"}]',
'title' => '查询域名DS记录',
'summary' => '调用QueryDSRecord查询域名DS记录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteDomainGroup' => [
'summary' => '删除超过1000个域名的分组为异步过程,需要等待系统处理。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => '域名分组编号,可通过[QueryDomainGroupList](~~69362~~)接口获取。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '123456',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"6176C174-F409-4311-BB09-E46CDE55E720\\"\\n}"},{"type":"xml","example":"\\n E577B435-A84B-4899-91BC-F7A5E5FB6956\\n","errorExample":"\\n E577B435-A84B-4899-91BC-F7A5E5FB6956\\n"}]',
'title' => '删除域名分组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDomainToDomainGroup' => [
'summary' => '如使用文件上传,替换超过1000个域名的分组,则该操作属于异步操作,需等待系统处理后才能看到结果。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'FileToUpload',
'in' => 'formData',
'schema' => [
'description' => 'base64编码的**xls**、**xlsx**文件,域名来源为文件时该字段为必须。文件中每行一个域名,单次上传最大支持文件大小为**2M**。',
'type' => 'string',
'required' => false,
'example' => 'dGVzdA==',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => '分组编号,可通过[QueryDomainGroupList](https://help.aliyun.com/document_detail/69362.html) 接口查询。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234',
],
],
[
'name' => 'Replace',
'in' => 'query',
'schema' => [
'description' => '是否替换当前分组中域名。取值:'."\n"
.'- **false**:向分组中新增域名;'."\n"
.'- **true**:替换分组中原有域名。',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'DataSource',
'in' => 'query',
'schema' => [
'description' => '域名数据来源。取值:'."\n"
.'- **1**:自定义输入域名;'."\n"
.'- **2**:文件上传。'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '自定义输入的域名,域名来源为自定义输入时,该字段为必须。',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
'example' => 'example.cn',
],
'required' => false,
'example' => 'example.com',
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"C7EE737A-5C01-4B82-A9BF-61DA846D57D2\\"\\n}"},{"type":"xml","example":"\\n B00B4D8C-2AF3-4EA1-8F39-579CE195C5D6\\n","errorExample":"\\n B00B4D8C-2AF3-4EA1-8F39-579CE195C5D6\\n"}]',
'title' => '向分组中设置域名',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveDomainGroup' => [
'summary' => '调用SaveDomainGroup创建、更新域名分组。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'DomainGroupName',
'in' => 'query',
'schema' => [
'description' => '域名分组名称。',
'type' => 'string',
'required' => true,
'example' => '测试分组',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => '域名分组编号,当不传该参数时为创建分组,传该参数时更新域名分组名称。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'BeingDeleted' => [
'description' => '是否正在删除中。'."\n"
.'> 超过1000个域名的分组删除为异步过程,需要系统处理一段时间,在此期间内该字段为**true**。',
'type' => 'boolean',
'example' => 'false',
],
'CreationDate' => [
'description' => '域名分组创建时间。',
'type' => 'string',
'example' => '2018-04-02 15:59:06',
],
'RequestId' => [
'description' => '唯一请求标识码。',
'type' => 'string',
'example' => '80011ABC-F573-4795-B0E8-377BFBBA3422',
],
'DomainGroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => '测试分组',
],
'ModificationDate' => [
'description' => '域名分组修改时间。',
'type' => 'string',
'example' => '2018-04-02 15:59:06',
],
'DomainGroupStatus' => [
'description' => '域名分组状态。取值:'."\n"
.'- **PROCESSING**:处理中;'."\n"
.'- **COMPLETE**:已完成。'."\n"
."\n"
.'> 通过文件设置分组、替换超过1000个域名的分组等情况下为异步过程,需要等待系统处理,此状态下该字段为**PROCESSING**。',
'type' => 'string',
'example' => 'COMPLETE',
],
'DomainGroupId' => [
'description' => '域名分组编号。',
'type' => 'integer',
'format' => 'int64',
'example' => '123456',
],
'TotalNumber' => [
'description' => '域名数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"BeingDeleted\\": false,\\n \\"CreationDate\\": \\"2018-04-02 15:59:06\\",\\n \\"RequestId\\": \\"80011ABC-F573-4795-B0E8-377BFBBA3422\\",\\n \\"DomainGroupName\\": \\"测试分组\\",\\n \\"ModificationDate\\": \\"2018-04-02 15:59:06\\",\\n \\"DomainGroupStatus\\": \\"COMPLETE\\",\\n \\"DomainGroupId\\": 123456,\\n \\"TotalNumber\\": 20\\n}","errorExample":"{\\n \\"BeingDeleted\\":false,\\n \\"CreationDate\\":\\"2018-04-27 14:53:55\\",\\n \\"DomainGroupId\\":123456,\\n \\"DomainGroupName\\":\\"测试分组\\",\\n \\"DomainGroupStatus\\":\\"COMPLETE\\",\\n \\"ModificationDate\\":\\"2018-04-27 14:53:55\\",\\n \\"RequestId\\":\\"3ADCCF7B-7D2B-4B2E-9154-3C0B6D43287A\\",\\n \\"TotalNumber\\":0\\n}"},{"type":"xml","example":"\\n 1234567\\n false\\n 测试分组1\\n A6145E95-96BA-4B17-B891-9CF3C4FBBA35\\n 2018-04-27 14:57:25\\n 2018-04-27 14:57:25\\n 0\\n COMPLETE\\n","errorExample":"\\n 1234567\\n false\\n 测试分组1\\n A6145E95-96BA-4B17-B891-9CF3C4FBBA35\\n 2018-04-27 14:57:25\\n 2018-04-27 14:57:25\\n 0\\n COMPLETE\\n"}]',
'title' => '保存域名分组',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainGroupList' => [
'summary' => '调用QueryDomainGroupList查询域名分组列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain0NKSXL',
],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可以设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'DomainGroupName',
'in' => 'query',
'schema' => [
'description' => '用户自定义的域名分组名称。',
'type' => 'string',
'required' => false,
'example' => '默认分组',
],
],
[
'name' => 'ShowDeletingGroup',
'in' => 'query',
'schema' => [
'description' => '是否展示正在删除中的域名分组,取值如下:'."\n"
."\n"
.'- **false**:否。'."\n"
.'- **true**:是。'."\n"
."\n"
.'默认为**false**。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'OrderKeyType',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'OrderByType',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求标识码。',
'type' => 'string',
'example' => '80011ABC-F573-4795-B0E8-377BFBBA3422',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainGroup' => [
'description' => '域名分组列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'BeingDeleted' => [
'description' => '是否正在删除中。超过1000个域名的分组删除为异步过程,需要系统处理一段时间,在此期间内该字段为**true**。',
'type' => 'boolean',
'example' => 'false',
],
'DomainGroupStatus' => [
'description' => '域名分组状态。取值:'."\n"
.'- **PROCESSING**:处理中;'."\n"
.'- **COMPLETE**:已完成。'."\n"
."\n"
.'> 通过文件设置分组、替换超过1000个域名的分组等情况下为异步过程,需要等待系统处理,此状态下该字段为**PROCESSING**。',
'type' => 'string',
'example' => 'COMPLETE',
],
'DomainGroupId' => [
'description' => '域名分组编号。',
'type' => 'string',
'example' => '-1',
],
'DomainGroupName' => [
'description' => '域名分组名称。',
'type' => 'string',
'example' => '未分组',
],
'ModificationDate' => [
'description' => '域名分组修改时间。',
'type' => 'string',
'example' => '2018-04-02 15:59:06',
],
'TotalNumber' => [
'description' => '域名数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'CreationDate' => [
'description' => '域名分组创建时间。',
'type' => 'string',
'example' => '2018-04-02 15:59:06',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"80011ABC-F573-4795-B0E8-377BFBBA3422\\",\\n \\"Data\\": {\\n \\"DomainGroup\\": [\\n {\\n \\"BeingDeleted\\": false,\\n \\"DomainGroupStatus\\": \\"COMPLETE\\",\\n \\"DomainGroupId\\": \\"-1\\",\\n \\"DomainGroupName\\": \\"未分组\\",\\n \\"ModificationDate\\": \\"2018-04-02 15:59:06\\",\\n \\"TotalNumber\\": 20,\\n \\"CreationDate\\": \\"2018-04-02 15:59:06\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"Data\\":{\\n \\"DomainGroup\\":[{\\n \\"BeingDeleted\\":false,\\n \\"CreationDate\\":\\"2018-04-27 14:48:02\\",\\n \\"DomainGroupId\\":-1,\\n \\"DomainGroupName\\":\\"未分组\\",\\n \\"DomainGroupStatus\\":\\"COMPLETE\\",\\n \\"TotalNumber\\":346\\n }]\\n },\\n \\"RequestId\\":\\"49F5586F-4D94-4909-8C6F-7DD5072ED08D\\"\\n}"},{"type":"xml","example":"\\n \\n \\n -1\\n false\\n 未分组\\n 2018-04-27 14:49:10\\n 346\\n COMPLETE\\n \\n \\n AA897378-08E9-4C34-98F9-8689F4EDC98E\\n","errorExample":"\\n \\n \\n -1\\n false\\n 未分组\\n 2018-04-27 14:49:10\\n 346\\n COMPLETE\\n \\n \\n AA897378-08E9-4C34-98F9-8689F4EDC98E\\n"}]',
'title' => '查询域名分组列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryServerLock' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例ID。',
'type' => 'string',
'required' => false,
'example' => 'S20181*****85212',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'StartDate' => [
'description' => '锁生效的时间。',
'type' => 'string',
'example' => '2021-07-10 17:37:36',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2021-07-10 17:37:36',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'ExpireDate' => [
'description' => '到期时间。',
'type' => 'string',
'example' => '2030-07-10 17:37:36',
],
'DomainName' => [
'description' => '查询的域名。',
'type' => 'string',
'example' => 'example.com',
],
'UserId' => [
'description' => '用户UID。',
'type' => 'string',
'example' => '121000000****',
],
'GmtModified' => [
'description' => '最近一次修改时间。',
'type' => 'string',
'example' => '2021-07-10 17:37:36',
],
'DomainInstanceId' => [
'description' => '域名实例ID。',
'type' => 'string',
'example' => 'S20190N1DAI4****',
],
'LockInstanceId' => [
'description' => '注册局锁实例ID。',
'type' => 'string',
'example' => 'S2021591IQ28****',
],
'ServerLockStatus' => [
'description' => '注册局锁状态。取值:'."\n"
."\n"
.'- 1:未开启'."\n"
.'- 2:已开启'."\n"
.'- 3:已关闭',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'LockProductId' => [
'description' => '锁产品ID。',
'type' => 'string',
'example' => '1807**',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"StartDate\\": \\"2021-07-10 17:37:36\\",\\n \\"GmtCreate\\": \\"2021-07-10 17:37:36\\",\\n \\"RequestId\\": \\"9DFCF6F8-243C-****-8035-4B12FEFD7D48\\",\\n \\"ExpireDate\\": \\"2030-07-10 17:37:36\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"UserId\\": \\"121000000****\\",\\n \\"GmtModified\\": \\"2021-07-10 17:37:36\\",\\n \\"DomainInstanceId\\": \\"S20190N1DAI4****\\",\\n \\"LockInstanceId\\": \\"S2021591IQ28****\\",\\n \\"ServerLockStatus\\": 2,\\n \\"LockProductId\\": \\"1807**\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2021-07-10 17:37:36\\n 2021-07-10 17:37:36\\n 9DFCF6F8-243C-****-8035-4B12FEFD7D48\\n 2030-07-10 17:37:36\\n example.com\\n 121000000****\\n 2021-07-10 17:37:36\\n S20190N1DAI4****\\n S2021591IQ28****\\n 2\\n 1807**\\n","errorExample":""}]',
'title' => '查询注册局锁详情',
'summary' => '查询域名在注册局的锁详情。',
],
'CheckProcessingServerLockApply' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'FeePeriod',
'in' => 'query',
'schema' => [
'description' => '购买周期年限,单位为**年**。范围为**1~10**年。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '待检查的域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'Exists' => [
'description' => '域名在注册局是否存在锁服务申请为**处理中**的状态。取值:'."\n"
."\n"
.'- true:存在'."\n"
.'- false:不存在',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9DFCF6F8-243C-****-8035-4B12FEFD7D48\\",\\n \\"Exists\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 9DFCF6F8-243C-****-8035-4B12FEFD7D48\\n true\\n","errorExample":""}]',
'title' => '检查是否有处理中的注册局锁申请记录',
'summary' => '检查域名在注册局,是否存在锁服务申请为“处理中”的状态。',
],
'CheckMaxYearOfServerLock' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '待检查的域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'CheckAction',
'in' => 'query',
'schema' => [
'description' => '购买的业务类型。取值:'."\n"
."\n"
.'- activate:新注'."\n"
.'- renew:续费',
'type' => 'string',
'required' => true,
'example' => 'activate',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'MaxYear' => [
'description' => '可购买的最大年限。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9DFCF6F8-243C-****-8035-4B12FEFD7D48\\",\\n \\"MaxYear\\": 10\\n}","errorExample":""},{"type":"xml","example":"\\n 9DFCF6F8-243C-****-8035-4B12FEFD7D48\\n 10\\n","errorExample":""}]',
'title' => '检查域名注册局锁最大可购买或续费的年限',
'summary' => '检测域名最大可购买或续费的年限。',
],
'ListServerLock' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '查询的域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'EndStartDate',
'in' => 'query',
'schema' => [
'description' => '查询截止时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2020-07-10 17:37:36',
],
],
[
'name' => 'BeginStartDate',
'in' => 'query',
'schema' => [
'description' => '查询开始时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2021-07-10 17:37:36',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '域名列表的分页页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '域名列表的分页大小。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
'default' => '500',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认值为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'LockProductId',
'in' => 'query',
'schema' => [
'description' => '锁产品ID。',
'type' => 'string',
'required' => false,
'example' => '1807**',
],
],
[
'name' => 'ServerLockStatus',
'in' => 'query',
'schema' => [
'description' => '注册局锁状态。取值为:'."\n"
."\n"
.'- 1:未开启'."\n"
.'- 2:已开启'."\n"
.'- 3:已关闭',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'StartExpireDate',
'in' => 'query',
'schema' => [
'description' => '起始过期时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2020-07-10 17:37:36',
],
],
[
'name' => 'EndExpireDate',
'in' => 'query',
'schema' => [
'description' => '截止过期时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2021-07-10 17:37:36',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'description' => '排序字段。',
'type' => 'string',
'required' => false,
'example' => 'EXPIRE_DATE',
'enum' => [
'EXPIRE_DATE',
],
],
],
[
'name' => 'OrderByType',
'in' => 'query',
'schema' => [
'description' => '业务内容(如注册时间、过期时间)的排序顺序。取值:ASC:升序。 DESC:倒序。 '."\n"
.'不传此参数默认为DESC。',
'type' => 'string',
'required' => false,
'example' => 'DESC',
'enum' => [
'DESC',
'ASC',
],
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。'."\n"
."\n",
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前域名列表的分页页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalPageNum' => [
'description' => '域名列表的总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Data' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ServerLockStatus' => [
'description' => '注册局锁状态。取值:'."\n"
."\n"
.'- 1:未开启'."\n"
.'- 2:已开启'."\n"
.'- 3:已关闭',
'type' => 'string',
'example' => '2',
],
'LockInstanceId' => [
'description' => '注册局锁实例ID。',
'type' => 'string',
'example' => 'S2021591IQ28****',
],
'UserId' => [
'description' => '阿里云用户编号。',
'type' => 'string',
'example' => '121000000****',
],
'GmtCreate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2020-02-19 16:38:07',
],
'ExpireDate' => [
'description' => '到期时间。',
'type' => 'string',
'example' => '2030-07-10 17:37:36',
],
'StartDate' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '2021-07-10 17:37:36',
],
'LockProductId' => [
'description' => '锁产品ID。',
'type' => 'string',
'example' => '1807**',
],
'DomainInstanceId' => [
'description' => '域名实例ID。',
'type' => 'string',
'example' => 'S20190N1DAI4****',
],
'GmtModified' => [
'description' => '最近一次修改时间。',
'type' => 'string',
'example' => '2022-02-19 16:40:38',
],
'DomainName' => [
'description' => '存在有效注册局锁信息的域名。',
'type' => 'string',
'example' => 'example.com',
],
],
],
],
'TotalItemNum' => [
'description' => '域名总记录数。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 0,\\n \\"RequestId\\": \\"9DFCF6F8-243C-****-8035-4B12FEFD7D48\\",\\n \\"PageSize\\": 5,\\n \\"TotalPageNum\\": 1,\\n \\"Data\\": [\\n {\\n \\"ServerLockStatus\\": \\"2\\",\\n \\"LockInstanceId\\": \\"S2021591IQ28****\\",\\n \\"UserId\\": \\"121000000****\\",\\n \\"GmtCreate\\": \\"2020-02-19 16:38:07\\",\\n \\"ExpireDate\\": \\"2030-07-10 17:37:36\\",\\n \\"StartDate\\": \\"2021-07-10 17:37:36\\",\\n \\"LockProductId\\": \\"1807**\\",\\n \\"DomainInstanceId\\": \\"S20190N1DAI4****\\",\\n \\"GmtModified\\": \\"2022-02-19 16:40:38\\",\\n \\"DomainName\\": \\"example.com\\"\\n }\\n ],\\n \\"TotalItemNum\\": 2,\\n \\"NextPage\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n false\\n 0\\n 9DFCF6F8-243C-****-8035-4B12FEFD7D48\\n 5\\n 1\\n \\n 2\\n S2021591IQ28****\\n 121000000****\\n 2020-02-19 16:38:07\\n 2030-07-10 17:37:36\\n 2021-07-10 17:37:36\\n 1807**\\n S20190N1DAI4****\\n 2022-02-19 16:40:38\\n example.com\\n \\n 2\\n false\\n","errorExample":""}]',
'title' => '查询注册局锁列表信息',
'summary' => '查询域名在注册局的锁列表信息。',
],
'SubmitOperationAuditInfo' => [
'summary' => '调用SubmitOperationAuditInfo提交自助业务审核信息。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。支持一个或多个域名,多个域名之间用英文逗号(,)分隔。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'xxxx.com,yyyy.cn',
],
],
[
'name' => 'AuditType',
'in' => 'query',
'schema' => [
'description' => '业务类型。取值:'."\n"
."\n"
.'**1**:线下转移域名,即将域名从当前的阿里云账号转移至另一个阿里云账号。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'AuditInfo',
'in' => 'query',
'schema' => [
'description' => '待审核信息,不同的业务类型显示的信息不同。',
'type' => 'string',
'required' => false,
'example' => '个人 {"regType":1,"registrantName":"张三","registrantNo":"2201919190**","telephone":"1390123****","account":"zhangsan@alimail.com","reason":1,"remark":"账号丢失"} 企业 {"regType":2,"registrantName":"华大信通","operatorName":"王武","operatorNo":"2201811987101901**", "operatorPhone":"1390123****","account":"wangwu@alimail.com","companyNo":"91361100MA35N6****","reason":2,"remark":"账号丢失"}',
],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'description' => '审核ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DKCF6F8-243C-40EC-8035-4B12FEFD7C22',
],
'Id' => [
'description' => '系统生成的记录ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9DKCF6F8-243C-40EC-8035-4B12FEFD7C22\\",\\n \\"Id\\": 1\\n}","errorExample":""},{"type":"xml","example":"\\n9DKCF6F8-243C-40EC-8035-4B12FEFD7C22\\n1\\n","errorExample":""}]',
'title' => '提交线下审核任务',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SubmitOperationCredentials' => [
'summary' => '调用SubmitOperationCredentials提交自助业务待审核的证件资料。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'AuditRecordId',
'in' => 'query',
'schema' => [
'description' => '审核记录ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RegType',
'in' => 'query',
'schema' => [
'description' => '域名持有者类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AuditType',
'in' => 'query',
'schema' => [
'description' => '审核类型。取值:'."\n"
."\n"
.'**1**:线下转移域名。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Credentials',
'in' => 'query',
'schema' => [
'description' => '待审核的证件资料信息。',
'type' => 'string',
'required' => false,
'example' => '[{"credentialType":"SHSQB",""credentialUrl":"11212121/1212d**/sqb.jpg"},{"credentialType":"SFZZM",""credentialUrl":"11212121/1212d**/sfzzm.jpg"}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-40EC-8035-4B12FEFX7D98',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9DFCF6F8-243C-40EC-8035-4B12FEFX7D98\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n9DFCF6F8-243C-40EC-8035-4B12FEFX7D98\\r\\n","errorExample":""}]',
'title' => '提交自助业务待审核的证件资料',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CancelOperationAudit' => [
'summary' => '调用CancelOperationAudit取消自助业务审核。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'AuditRecordId',
'in' => 'query',
'schema' => [
'description' => '审核记录ID。您可以通过[QueryOperationAuditInfoList](~~172568~~)接口查询审核记录ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9KFCF6F8-243C-40EC-8035-4B12KKFD7D90',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9KFCF6F8-243C-40EC-8035-4B12KKFD7D90\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n9KFCF6F8-243C-40EC-8035-4B12KKFD7D90\\r\\n","errorExample":""}]',
'title' => '取消线下审核申请',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CancelQualificationVerification' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号。',
'type' => 'string',
'required' => true,
'example' => 'S20181*****85212',
],
],
[
'name' => 'QualificationType',
'in' => 'query',
'schema' => [
'description' => '资质审核接口类型。固定取值为**knet**。',
'type' => 'string',
'required' => true,
'example' => 'knet',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9DFCF6F8-243C-****-8035-4B12FEFD7D48\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9DFCF6F8-243C-****-8035-4B12FEFD7D48\\n","errorExample":""}]',
'title' => '取消资质审核',
'summary' => '取消“.餐厅”、“.商标”域名资质审核。',
],
'ResetQualificationVerification' => [
'summary' => '.餐厅、.商标域名重置资质审核状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '域名实例编号。',
'type' => 'string',
'required' => true,
'example' => 'S20181*****85212',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'D6CB3623-4726-4947-AC2B-2C6E673B447C',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D6CB3623-4726-4947-AC2B-2C6E673B447C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D6CB3623-4726-4947-AC2B-2C6E673B447C\\n","errorExample":""}]',
'title' => '重置资质审核状态',
],
'SaveRegistrantProfileRealNameVerification' => [
'summary' => '调用SaveRegistrantProfileRealNameVerification接口保存域名联系人和证件信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Country',
'in' => 'query',
'schema' => [
'description' => '国家代码,例如**CN**。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。'."\n"
."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文'."\n"
.'- **en**:英文'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '待保存的信息模板的编号。'."\n"
."\n"
.'信息模板创建成功后由系统自动生成,您可以调用[QueryRegistrantProfiles](https://help.aliyun.com/document_detail/67701.html)接口查询信息模板编号。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1234567',
],
],
[
'name' => 'City',
'in' => 'query',
'schema' => [
'description' => '城市(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'bei jing shi',
],
],
[
'name' => 'RegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'ce shi',
],
],
[
'name' => 'RegistrantName',
'in' => 'query',
'schema' => [
'description' => '域名联系人(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'ce shi',
],
],
[
'name' => 'Province',
'in' => 'query',
'schema' => [
'description' => '省份(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'bei jing',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'description' => '详细地址(英文)。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'chao yang qu',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => '电子邮箱。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => 'username@example.com',
],
],
[
'name' => 'PostalCode',
'in' => 'query',
'schema' => [
'description' => '邮政编码。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '1234567',
],
],
[
'name' => 'TelArea',
'in' => 'query',
'schema' => [
'description' => '电话国家代码。'."\n"
."\n"
.'>例如,中国的电话国家代码为**86**。'."\n",
'type' => 'string',
'required' => false,
'example' => '86',
],
],
[
'name' => 'Telephone',
'in' => 'query',
'schema' => [
'description' => '电话号码。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '12345678',
],
],
[
'name' => 'TelExt',
'in' => 'query',
'schema' => [
'description' => '分机号码。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '1234',
],
],
[
'name' => 'ZhRegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '域名持有者名称(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'ZhRegistrantName',
'in' => 'query',
'schema' => [
'description' => '域名联系人(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '测试',
],
],
[
'name' => 'ZhProvince',
'in' => 'query',
'schema' => [
'description' => '省份(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '北京',
],
],
[
'name' => 'ZhAddress',
'in' => 'query',
'schema' => [
'description' => '详细地址(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '朝阳区',
],
],
[
'name' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '城市(中文)。'."\n"
."\n"
.'> 该参数仅适用于中国站。当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '北京市',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '域名持有者类型。取值:'."\n"
.'- **1**:个人。'."\n"
.'- **2**:企业、组织等。'."\n"
."\n"
.'> 当未传入**RegistrantProfileId**参数时,本参数才可用且必须传入,如果不传入会导致域名注册失败。',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RegistrantProfileType',
'in' => 'query',
'schema' => [
'description' => '信息模板类型。取值:'."\n"
.'- **common**:通用模板。'."\n"
.'- **cnnic**:cnnic模板。'."\n"
."\n"
.'> cnnic模板仅国际站支持,在阿里云国际站注册的“.cn”、“.中国”等CNNIC注册局下的域名需使用cnnic模板,其他域名使用通用模板。',
'type' => 'string',
'required' => false,
'example' => 'common',
],
],
[
'name' => 'IdentityCredential',
'in' => 'query',
'schema' => [
'description' => '采用Base64编码的实名认证资料图片。图片要求如下:'."\n"
.'- 图片为**jpg**或**bmp**格式。'."\n"
.'- 原图片大小为**55K~1M**。',
'type' => 'string',
'required' => false,
'example' => 'dGVzdA==',
],
],
[
'name' => 'IdentityCredentialNo',
'in' => 'query',
'schema' => [
'description' => '实名认证证件号码。',
'type' => 'string',
'required' => false,
'example' => '4111111111111110**',
],
],
[
'name' => 'IdentityCredentialType',
'in' => 'query',
'schema' => [
'description' => '实名认证证件类型。取值:'."\n"
.'- **SFZ**:身份证。'."\n"
.'- **HZ**:护照。'."\n"
.'- **YYZZ**:营业执照。'."\n"
.'- **ORG**:组织机构代码证。'."\n"
.'- **XYDM**:统一社会信用代码证书。'."\n"
.'- **TXZ**:港澳居民来往内地通行证。'."\n"
."\n"
.'> 更多证件类型的取值请参见[支持实名认证的证件类型](https://help.aliyun.com/document_detail/72209.html)。',
'type' => 'string',
'required' => false,
'example' => 'SFZ',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RegistrantProfileId' => [
'description' => '查询到的信息模板的编号。',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4D73432C-7600-****-ACBB-C3B5CA145D32',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RegistrantProfileId\\": 1234567,\\n \\"RequestId\\": \\"4D73432C-7600-****-ACBB-C3B5CA145D32\\"\\n}","errorExample":""},{"type":"xml","example":"\\n4D73432C-7600-****-ACBB-C3B5CA145D32\\n1234567\\n","errorExample":""}]',
'title' => '保存域名信息实名验证',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFailingReasonListForQualification' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'QualificationType',
'in' => 'query',
'schema' => [
'description' => '资质审核接口类型。固定取值**knet**。',
'type' => 'string',
'required' => true,
'example' => 'knet',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认值为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例编号。',
'type' => 'string',
'required' => true,
'example' => 'S20181*****85212',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '查询的记录数。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'Data' => [
'description' => '域名资质审核失败列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Date' => [
'description' => '审核日期。',
'type' => 'string',
'example' => '2017-03-17 11:08:02',
],
'FailReason' => [
'description' => '域名资质审核失败原因。',
'type' => 'string',
'example' => '证件审核不通过',
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9DFCF6F8-243C-****-8035-4B12FEFD7D48\\",\\n \\"Data\\": [\\n {\\n \\"Date\\": \\"2017-03-17 11:08:02\\",\\n \\"FailReason\\": \\"证件审核不通过\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 9DFCF6F8-243C-****-8035-4B12FEFD7D48\\n \\n 2017-03-17 11:08:02\\n 证件审核不通过\\n \\n","errorExample":""}]',
'title' => '查询资质审核失败原因',
'summary' => '查询“.餐厅”、“.商标”域名资质审核失败原因。',
],
'QueryOperationAuditInfoDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'AuditRecordId',
'in' => 'query',
'schema' => [
'description' => '审核记录ID。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AuditInfo' => [
'description' => '审核信息。',
'type' => 'string',
'example' => '{"regType":1,"registrantName":"张三","telephone":"1390123****","account":"username@example.com","reason":1,"remark":"账号丢失"}',
],
'AuditStatus' => [
'description' => '审核状态。取值:'."\n"
.'- **0**:待完善资料。'."\n"
.'- **1**、**2**、**3**、**4**:审核中。'."\n"
.'- **5**:审核失败。'."\n"
.'- **6**:审核成功。'."\n"
.'- **7**:取消审核。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-40EC-8035-4B12FEFD7D1L',
],
'BusinessName' => [
'description' => '审核业务名称。',
'type' => 'string',
'example' => 'example.com等域名线下转移',
],
'AuditType' => [
'description' => '审核类型。取值:'."\n"
."\n"
.'**1**:线下转移域名。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com,aliyundoc.com',
],
'CreateTime' => [
'description' => '记录创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1581919010100',
],
'UpdateTime' => [
'description' => '记录更新时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1581919010101',
],
'Id' => [
'description' => '审核记录ID。',
'type' => 'string',
'example' => '1',
],
'Remark' => [
'description' => '审核备注。',
'type' => 'string',
'example' => '审核通过',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AuditInfo\\": \\"{\\\\\\"regType\\\\\\":1,\\\\\\"registrantName\\\\\\":\\\\\\"张三\\\\\\",\\\\\\"telephone\\\\\\":\\\\\\"1390123****\\\\\\",\\\\\\"account\\\\\\":\\\\\\"username@example.com\\\\\\",\\\\\\"reason\\\\\\":1,\\\\\\"remark\\\\\\":\\\\\\"账号丢失\\\\\\"}\\",\\n \\"AuditStatus\\": 1,\\n \\"RequestId\\": \\"9DFCF6F8-243C-40EC-8035-4B12FEFD7D1L\\",\\n \\"BusinessName\\": \\"example.com等域名线下转移\\",\\n \\"AuditType\\": 1,\\n \\"DomainName\\": \\"example.com,aliyundoc.com\\",\\n \\"CreateTime\\": 1581919010100,\\n \\"UpdateTime\\": 1581919010101,\\n \\"Id\\": \\"1\\",\\n \\"Remark\\": \\"审核通过\\"\\n}","errorExample":""},{"type":"xml","example":"\\n{\\"regType\\":1,\\"registrantName\\":\\"张三\\",\\"telephone\\":\\"1390123****\\",\\"account\\":\\"username@example.com\\",\\"reason\\":1,\\"remark\\":\\"账号丢失\\"}\\n1\\n9DFCF6F8-243C-40EC-8035-4B12FEFD7D1L\\nexample.com等域名线下转移\\nexample.com,aliyundoc.com\\n1\\n1581919010100\\n1581919010101\\n1\\n审核通过\\n","errorExample":""}]',
'title' => '查询线下审核任务详情',
'summary' => '调用QueryOperationAuditInfoDetail查询自助业务的审核记录详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryOperationAuditInfoList' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '需要查询的域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'AuditType',
'in' => 'query',
'schema' => [
'description' => '审核类型。取值:'."\n"
."\n"
.'**1**:线下转移域名。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AuditStatus',
'in' => 'query',
'schema' => [
'description' => '审核状态。取值:'."\n"
."\n"
.'- **0**:待完善资料。'."\n"
.'- **1**、**2**、**3**、**4**:审核中。'."\n"
.'- **5**:审核失败。'."\n"
.'- **6**:审核成功。'."\n"
.'- **7**:取消审核。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页记录数。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'example' => '20',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '页码。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。',
'type' => 'boolean',
'example' => 'true',
],
'CurrentPageNum' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-40EC-8035-4B12FEFD7D48',
],
'PageSize' => [
'description' => '每页记录数。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalPageNum' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Data' => [
'description' => '审核数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UpdateTime' => [
'description' => '记录更新时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1581919010101',
],
'Remark' => [
'description' => '审核备注。',
'type' => 'string',
'example' => '审核中',
],
'CreateTime' => [
'description' => '记录创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1581919010101',
],
'AuditType' => [
'description' => '审核类型。取值:'."\n"
."\n"
.'**1**:线下转移域名。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BusinessName' => [
'description' => '审核业务的名称。',
'type' => 'string',
'example' => 'example.com等域名线下转移',
],
'AuditInfo' => [
'description' => '待审核信息。',
'type' => 'string',
'example' => '{"regType":1,"registrantName":"张三","telephone":"1390123****","account":"username@example.com","reason":1,"remark":"账号丢失"}',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com,aliyundoc.com',
],
'AuditStatus' => [
'description' => '审核状态。取值:'."\n"
."\n"
.'- **0**:待完善资料。'."\n"
.'- **1**、**2**、**3**、**4**:审核中。'."\n"
.'- **5**:审核失败。'."\n"
.'- **6**:审核成功。'."\n"
.'- **7**:取消审核。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Id' => [
'description' => '审核记录ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
],
'TotalItemNum' => [
'description' => '总记录数。',
'type' => 'integer',
'format' => 'int32',
'example' => '199',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": true,\\n \\"CurrentPageNum\\": 2,\\n \\"RequestId\\": \\"9DFCF6F8-243C-40EC-8035-4B12FEFD7D48\\",\\n \\"PageSize\\": 20,\\n \\"TotalPageNum\\": 10,\\n \\"Data\\": [\\n {\\n \\"UpdateTime\\": 1581919010101,\\n \\"Remark\\": \\"审核中\\",\\n \\"CreateTime\\": 1581919010101,\\n \\"AuditType\\": 1,\\n \\"BusinessName\\": \\"example.com等域名线下转移\\",\\n \\"AuditInfo\\": \\"{\\\\\\"regType\\\\\\":1,\\\\\\"registrantName\\\\\\":\\\\\\"张三\\\\\\",\\\\\\"telephone\\\\\\":\\\\\\"1390123****\\\\\\",\\\\\\"account\\\\\\":\\\\\\"username@example.com\\\\\\",\\\\\\"reason\\\\\\":1,\\\\\\"remark\\\\\\":\\\\\\"账号丢失\\\\\\"}\\",\\n \\"DomainName\\": \\"example.com,aliyundoc.com\\",\\n \\"AuditStatus\\": 1,\\n \\"Id\\": 1\\n }\\n ],\\n \\"TotalItemNum\\": 199,\\n \\"NextPage\\": true\\n}","errorExample":""},{"type":"xml","example":"true\\n2\\n20\\n9DFCF6F8-243C-40EC-8035-4B12FEFD7D48\\n10\\n\\n {\\"regType\\":1,\\"registrantName\\":\\"张三\\",\\"telephone\\":\\"1390123****\\",\\"account\\":\\"username@example.com\\",\\"reason\\":1,\\"remark\\":\\"账号丢失\\"}\\n 1\\n example.com等域名线下转移\\n 1\\n example.com,aliyundoc.com\\n 1581919010101\\n 1581919010101\\n 1\\n 审核中\\n\\n199\\ntrue","errorExample":""}]',
'title' => '查询线下审核任务列表',
'summary' => '调用QueryOperationAuditInfoList查询自助业务的审核记录列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryQualificationDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例编号。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'S20181*****85212',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'QualificationType',
'in' => 'query',
'schema' => [
'description' => '资质审核接口类型。固定取值**knet**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'knet',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AuditStatus' => [
'description' => '审核状态。取值:'."\n"
."\n"
.'- 0:待完善资料。'."\n"
.'- 1、2、3、4:审核中。'."\n"
.'- 5:审核失败。'."\n"
.'- 6:审核成功。'."\n"
.'- 7:取消审核。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'Credentials' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'QualificationCredential' => [
'description' => '资质审核资料信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CredentialType' => [
'description' => '资质审核的证件类型。',
'type' => 'string',
'example' => 'SHSQB',
],
'CredentialNo' => [
'description' => '资质审核的证件号码。',
'type' => 'string',
'example' => '92610725MA7G2E****',
],
'CredentialUrl' => [
'description' => '资质审核的证件照URL。',
'type' => 'string',
'example' => '11212121/1212d**/sqb.jpg',
],
],
],
],
],
],
'TrackId' => [
'description' => '资质审核业务跟踪号。',
'type' => 'string',
'example' => '943a1662898a****0acbdbeca91',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AuditStatus\\": 1,\\n \\"RequestId\\": \\"9DFCF6F8-243C-****-8035-4B12FEFD7D48\\",\\n \\"Credentials\\": {\\n \\"QualificationCredential\\": [\\n {\\n \\"CredentialType\\": \\"SHSQB\\",\\n \\"CredentialNo\\": \\"92610725MA7G2E****\\",\\n \\"CredentialUrl\\": \\"11212121/1212d**/sqb.jpg\\"\\n }\\n ]\\n },\\n \\"TrackId\\": \\"943a1662898a****0acbdbeca91\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 9DFCF6F8-243C-****-8035-4B12FEFD7D48\\n \\n SHSQB\\n 92610725MA7G2E****\\n 11212121/1212d**/sqb.jpg\\n \\n 943a1662898a****0acbdbeca91\\n","errorExample":""}]',
'title' => '查询资质审核详情',
'summary' => '查询“.餐厅”、“.商标”域名资质审核详情。',
],
'GetOperationOssUploadPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'AuditType',
'in' => 'query',
'schema' => [
'description' => '审核类型。取值:'."\n"
."\n"
.'**1**:线下转移域名。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'FileDir' => [
'description' => '文件地址。',
'type' => 'string',
'example' => '1219541161213157/OFFLINE_TRANSFER/159368851****',
],
'EncodedPolicy' => [
'description' => '加密策略。',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAaMC0wNy0wMlQxKToyMDoxMS44ODRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiMTIxOTU0MTE2MTIxMzA1Ny9PRkZMSU5FX1RSQU5TRkVSLzE1OTM2ODg1MTE4ODMi****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-40EC-8035-4B12FEFD7D011',
],
'Accessid' => [
'description' => '访问ID。',
'type' => 'string',
'example' => 'hObpgEXoca42****',
],
'Signature' => [
'description' => '签名数据。',
'type' => 'string',
'example' => 'pNVECGkyL0tl4bKXekV5ErZ****',
],
'Host' => [
'description' => 'OSS终端/接入地址。',
'type' => 'string',
'example' => '//***-basic-cert.oss-cn-***.aliyuncs.com/',
],
'ExpireTime' => [
'description' => '过期时间。',
'type' => 'string',
'example' => '1593688811881',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"FileDir\\": \\"1219541161213157/OFFLINE_TRANSFER/159368851****\\",\\n \\"EncodedPolicy\\": \\"eyJleHBpcmF0aW9uIjoiMjAaMC0wNy0wMlQxKToyMDoxMS44ODRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiMTIxOTU0MTE2MTIxMzA1Ny9PRkZMSU5FX1RSQU5TRkVSLzE1OTM2ODg1MTE4ODMi****\\",\\n \\"RequestId\\": \\"9DFCF6F8-243C-40EC-8035-4B12FEFD7D011\\",\\n \\"Accessid\\": \\"hObpgEXoca42****\\",\\n \\"Signature\\": \\"pNVECGkyL0tl4bKXekV5ErZ****\\",\\n \\"Host\\": \\"//***-basic-cert.oss-cn-***.aliyuncs.com/\\",\\n \\"ExpireTime\\": \\"1593688811881\\"\\n}","errorExample":""},{"type":"xml","example":"\\n1219541161213157/OFFLINE_TRANSFER/159368851****\\neyJleHBpcmF0aW9uIjoiMjAaMC0wNy0wMlQxKToyMDoxMS44ODRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiMTIxOTU0MTE2MTIxMzA1Ny9PRkZMSU5FX1RSQU5TRkVSLzE1OTM2ODg1MTE4ODMi****\\n9DFCF6F8-243C-40EC-8035-4B12FEFD7D011\\nhObpgEXoca42****\\npNVECGkyL0tl4bKXekV5ErZ****\\n//***-basic-cert.oss-cn-***.aliyuncs.com/\\n1593688811881\\n","errorExample":""}]',
'title' => '获取线下审核OSS上传策略',
'summary' => '调用GetOperationOssUploadPolicy获取审核资料的存储信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForDomainNameProxyService' => [
'summary' => '调用SaveBatchTaskForDomainNameProxyService提交批量域名隐私保护服务任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '开启或关闭状态。取值:'."\n"
.'- **true**:开启。'."\n"
.'- **false**:关闭。',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名列表,多个域名之间用英文(,)隔开。',
'type' => 'array',
'items' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
'required' => true,
'example' => 'test1.com,test2.com,test3.com',
'maxItems' => 1000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f54923',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\",\\n \\"TaskNo\\": \\"d3babb0a-c939-4c25-8c65-c47b65f54923\\"\\n}","errorExample":""},{"type":"xml","example":"\\nd3babb0a-c939-4c25-8c65-c47b65f5492a\\nF51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\n","errorExample":""}]',
'title' => '提交批量域名隐私保护服务任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForDomainNameProxyService' => [
'summary' => '调用SaveSingleTaskForDomainNameProxyService提交域名隐私保护服务任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '开启关闭状态。取值:'."\n"
.'- **true**:开启;'."\n"
.'- **false**:关闭。'."\n"
.' ',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F51977F9-2B40-462B-BCCD-CF5BB1E9DB56\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","errorExample":""},{"type":"xml","example":"\\n EDC28FEC-6BE0-4583-95BC-test\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n","errorExample":""}]',
'title' => '提交域名隐私保护服务任务',
'description' => '调用SaveSingleTaskForDomainNameProxyService提交域名隐私保护服务任务。',
],
'SaveTaskForSubmittingDomainDelete' => [
'summary' => '提交删除域名任务,仅白名单用户可以访问。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文。'."\n"
.'- en:英文。'."\n"
."\n"
.'默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '实例编号。',
'type' => 'string',
'required' => true,
'example' => 'S20181*****85212',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '23C9B3C4-9E2C-4405-A88D-BD33E459D140',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"23C9B3C4-9E2C-4405-A88D-BD33E459D140\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 23C9B3C4-9E2C-4405-A88D-BD33E459D140\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n","errorExample":""}]',
'title' => '提交域名删除任务',
'description' => '调用SaveTaskForSubmittingDomainDelete提交域名删除任务。',
],
'SaveSingleTaskForAssociatingEns' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'test.luxe',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'description' => 'Ens地址。',
'type' => 'string',
'required' => true,
'example' => '0x1234567890123456789012345678901234567890',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e893148f-6343-4ae1-9eba-6e2a4116e142',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\": \\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\":\\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}"},{"type":"xml","example":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n","errorExample":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n"}]',
'title' => '提交绑定Ens地址任务',
'summary' => '提交绑定Ens地址任务。',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForDisassociatingEns' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'test.luxe',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e893148f-6343-4ae1-9eba-6e2a4116e142',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\": \\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\":\\"e893148f-6343-4ae1-9eba-6e2a4116e142\\"\\n}"},{"type":"xml","example":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n","errorExample":"\\n 3cbc5b9f-080d-4b5f-a04b-29f54bffdeab\\n 722D0361-93BD-4289-824F-D17B218D8BF4\\n"}]',
'title' => '提交解绑Ens地址任务',
'summary' => '调用SaveSingleTaskForDisassociatingEns提交解绑Ens地址任务。',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。'."\n"
.' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchDomainRemark' => [
'summary' => '调用SaveBatchDomainRemark批量保存域名备注。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**,此参数为必填项。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => '备注信息。',
'type' => 'string',
'required' => false,
'example' => 'MyRemarkInfo',
],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => [
'description' => '实例编号列表,建议**10**条一组,每组最多**50**条,以逗号(,)隔开。',
'type' => 'string',
'required' => true,
'example' => 'S12344567',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '4189E320-961E-4786-8E15-0000',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4189E320-961E-4786-8E15-0000\\"\\n}","errorExample":"{\\n \\"requestId\\": \\"F7C66E24-0134-4E53-9A31-0000\\"\\n}"},{"type":"xml","example":"\\n\\n 4189E320-961E-4786-8E15-0000\\n","errorExample":"\\n\\n 4189E320-961E-4786-8E15-0000\\n"}]',
'title' => '批量保存域名备注',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForSaveArtExtension' => [
'summary' => '调用SaveSingleTaskForSaveArtExtension提交创建Art扩展信息任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'test.art',
],
],
[
'name' => 'ObjectType',
'in' => 'query',
'schema' => [
'description' => '艺术品分类。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'The embroidery',
],
],
[
'name' => 'MaterialsAndTechniques',
'in' => 'query',
'schema' => [
'description' => '材质与工艺。',
'type' => 'string',
'required' => false,
'example' => 'silk',
],
],
[
'name' => 'Dimensions',
'in' => 'query',
'schema' => [
'description' => '尺寸。',
'type' => 'string',
'required' => false,
'example' => '20 cm',
],
],
[
'name' => 'Title',
'in' => 'query',
'schema' => [
'description' => '名称。',
'type' => 'string',
'required' => false,
'example' => 'Peace and friendship',
],
],
[
'name' => 'DateOrPeriod',
'in' => 'query',
'schema' => [
'description' => '创作时间。',
'type' => 'string',
'required' => false,
'example' => '2019-10-01',
],
],
[
'name' => 'Maker',
'in' => 'query',
'schema' => [
'description' => '艺术家、创作者。'."\n",
'type' => 'string',
'required' => false,
'example' => 'zhang san',
],
],
[
'name' => 'InscriptionsAndMarkings',
'in' => 'query',
'schema' => [
'description' => '题词和标识。',
'type' => 'string',
'required' => false,
'example' => 'realism',
],
],
[
'name' => 'Subject',
'in' => 'query',
'schema' => [
'description' => '艺术主题。',
'type' => 'string',
'required' => false,
'example' => 'peace',
],
],
[
'name' => 'Features',
'in' => 'query',
'schema' => [
'description' => '艺术特征。',
'type' => 'string',
'required' => false,
'example' => 'iconicity',
],
],
[
'name' => 'Reference',
'in' => 'query',
'schema' => [
'description' => '参考。',
'type' => 'string',
'required' => false,
'example' => 'drawings',
],
],
[
'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' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AB',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => 'e893148f-6343-4ae1-9eba-6e2a4116e141',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AB\\",\\n \\"TaskNo\\": \\"e893148f-6343-4ae1-9eba-6e2a4116e141\\"\\n}","errorExample":"{\\n \\"RequestId\\":\\"E2598CAF-DBFE-494E-95EF-B42A33C178AB\\",\\n \\"TaskNo\\":\\"e893148f-6343-4ae1-9eba-6e2a4116e141\\"\\n}"},{"type":"xml","example":"\\n 3cbc5b9f-080d-4b5f-a04b-6e2a4116e141\\n 722D0361-93BD-4289-824F-B42A33C178AB\\n","errorExample":"\\n 3cbc5b9f-080d-4b5f-a04b-6e2a4116e141\\n 722D0361-93BD-4289-824F-B42A33C178AB\\n"}]',
'title' => '提交创建Art扩展信息任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~67710~~)接口查询。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryChangeLogList' => [
'summary' => '调用QueryChangeLogList分页查询您当前阿里云账号下的操作日志。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomainBJEHHJ',
'FEATUREdomain9WEVJX',
'FEATUREdomain9191Y6',
],
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '待查询操作日志的域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '分页页码,最小值为**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页大小,最小值为**1**,最大值为**100**。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '查询操作日期的开始时间,UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '查询操作日期的结束时间,UTC时间1970年1月1日0点距离现在的毫秒数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => '是否有上一页。',
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '2DEDFF32-7827-46B1-BE90-3DB8ABD91A58',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPageNum' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ChangeLog' => [
'description' => '操作日志列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Operation' => [
'description' => '操作行为。',
'type' => 'string',
'example' => 'DNS modification',
],
'Time' => [
'description' => '操作时间,UTC时间,如2017-12-25 12:00:00,具体格式与入参Lang有关。',
'type' => 'string',
'example' => '2017-12-26 12:00:00',
],
'Result' => [
'description' => '操作结果。',
'type' => 'string',
'example' => 'Failed',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'OperationIPAddress' => [
'description' => '操作IP。',
'type' => 'string',
'example' => '127.0.0.1',
],
'Details' => [
'description' => '详情。',
'type' => 'string',
'example' => 'dns1;dns2 -> dns3;dns4',
],
'Remark' => [
'type' => 'string',
],
],
],
],
],
],
'ResultLimit' => [
'description' => '当前查询除分页限制外,服务端最多处理最近1000条记录。如结果超过1000条,**ResultLimit**为**true**,请缩小时间范围重新搜索;否则**ResultLimit**为**false**。'."\n"
.' ',
'type' => 'boolean',
'example' => 'true',
],
'TotalItemNum' => [
'description' => '记录总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1000',
],
'NextPage' => [
'description' => '是否有下一页。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 1,\\n \\"RequestId\\": \\"2DEDFF32-7827-46B1-BE90-3DB8ABD91A58\\",\\n \\"PageSize\\": 1,\\n \\"TotalPageNum\\": 1000,\\n \\"Data\\": {\\n \\"ChangeLog\\": [\\n {\\n \\"Operation\\": \\"DNS modification\\",\\n \\"Time\\": \\"2017-12-26 12:00:00\\",\\n \\"Result\\": \\"Failed\\",\\n \\"DomainName\\": \\"example.com\\",\\n \\"OperationIPAddress\\": \\"127.0.0.1\\",\\n \\"Details\\": \\"dns1;dns2 -> dns3;dns4\\",\\n \\"Remark\\": \\"\\"\\n }\\n ]\\n },\\n \\"ResultLimit\\": true,\\n \\"TotalItemNum\\": 1000,\\n \\"NextPage\\": true\\n}","errorExample":""},{"type":"xml","example":"false\\n1\\n1\\n2DEDFF32-7827-46B1-BE90-3DB8ABD91A58\\n1000\\n\\n \\n 127.0.0.1\\n dns1;dns2 -> dns3;dns4 \\n example.com\\n \\n DNS modification\\n Failed\\n \\n\\ntrue\\n1000\\ntrue","errorExample":"\\n\\n \\n \\n Failed\\n DNS modification\\n \\n dns1;dns2 -> dns3;dns4 \\n test1.com\\n 127.0.0.1\\n \\n \\n 1000\\n 1\\n 1\\n 2DEDFF32-7827-46B1-BE90-3DB8ABD91A58\\n false\\n 1000\\n true\\n true\\n"}]',
'title' => '查询操作日志列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryLocalEnsAssociation' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'test.luxe',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文;'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Address' => [
'description' => '阿里云系统中记录的Ens地址。',
'type' => 'string',
'example' => '3ECD5439-39A2-477D-9A19-64FCA1F77EEB',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '0x1234567890123456789012345678901234567890',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Address\\": \\"3ECD5439-39A2-477D-9A19-64FCA1F77EEB\\",\\n \\"RequestId\\": \\"0x1234567890123456789012345678901234567890\\"\\n}","errorExample":"{\\n \\"Address\\":\\"0x1234567890123456789012345678901234567890\\",\\n \\"RequestId\\":\\"3ECD5439-39A2-477D-9A19-64FCA1F77EEB\\"\\n}"},{"type":"xml","example":"\\n 0x1234567890123456789012345678901234567890\\n D60028B6-4ED1-486C-BA6E-E0B0A8284BE4\\n","errorExample":"\\n 0x1234567890123456789012345678901234567890\\n D60028B6-4ED1-486C-BA6E-E0B0A8284BE4\\n"}]',
'title' => '查询本地Ens绑定地址',
'summary' => '调用QueryLocalEnsAssociation查询阿里云系统中记录的ens绑定地址。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryEnsAssociation' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'test.luxe',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**en**。'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Address' => [
'description' => 'ens系统中的钱包地址。',
'type' => 'string',
'example' => '0x123456789012345678901234567890123456****',
],
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '3ECD5439-39A2-477D-9A19-64FCA1F77EEB',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Address\\": \\"0x123456789012345678901234567890123456****\\",\\n \\"RequestId\\": \\"3ECD5439-39A2-477D-9A19-64FCA1F77EEB\\"\\n}","errorExample":"{\\n \\"Address\\":\\"0x1234567890123456789012345678901234567890\\",\\n \\"RequestId\\":\\"3ECD5439-39A2-477D-9A19-64FCA1F77EEB\\"\\n}"},{"type":"xml","example":"\\n 0x123456789012345678901234567890123456****\\n D60028B6-4ED1-486C-BA6E-E0B0A8284BE4\\n","errorExample":"\\n 0x1234567890123456789012345678901234567890\\n D60028B6-4ED1-486C-BA6E-E0B0A8284BE4\\n"}]',
'title' => '查询Ens系统中绑定的钱包地址',
'summary' => '调用QueryEnsAssociation查询Ens系统中绑定的钱包地址。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetQualificationUploadPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
."\n"
.'- zh:中文'."\n"
.'- en:英文'."\n"
."\n"
.'默认为en。',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户IP,可设置为**127.0.0.1**。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Policy' => [
'description' => '加密策略。',
'type' => 'string',
'example' => 'eyJleHBpcmF0aW9uIjoiMjAaMC0wNy0wMlQxKToyMDoxMS44ODRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiMTIxOTU0MTE2MTIxMzA1Ny9PRkZMSU5FX1RSQU5TRkVSLzE1OTM2ODg1MTE4ODMi****',
],
'Expire' => [
'description' => '过期时间。',
'type' => 'string',
'example' => '1593688811881',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'Accessid' => [
'description' => '访问ID。',
'type' => 'string',
'example' => 'hObpgEXoca42****',
],
'Signature' => [
'description' => '签名数据。',
'type' => 'string',
'example' => 'pNVECGkyL0tl4bKXekV5ErZ****',
],
'Host' => [
'description' => 'OSS的Endpoint。',
'type' => 'string',
'example' => 'https://********-review.oss-cn-********.aliyuncs.com',
],
'Prefix' => [
'description' => '文件前缀。',
'type' => 'string',
'example' => '20211220/131953297274****_4de3db85-4f98-488d-845b-d75bf035b13d_${filename}',
],
'Dir' => [
'description' => '文件地址。',
'type' => 'string',
'example' => '20211220/131953297274****_4de3db85-4f98-488d-845b-d75bf035b13d',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAaMC0wNy0wMlQxKToyMDoxMS44ODRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiMTIxOTU0MTE2MTIxMzA1Ny9PRkZMSU5FX1RSQU5TRkVSLzE1OTM2ODg1MTE4ODMi****\\",\\n \\"Expire\\": \\"1593688811881\\",\\n \\"RequestId\\": \\"9DFCF6F8-243C-****-8035-4B12FEFD7D48\\",\\n \\"Accessid\\": \\"hObpgEXoca42****\\",\\n \\"Signature\\": \\"pNVECGkyL0tl4bKXekV5ErZ****\\",\\n \\"Host\\": \\"https://********-review.oss-cn-********.aliyuncs.com\\",\\n \\"Prefix\\": \\"20211220/131953297274****_4de3db85-4f98-488d-845b-d75bf035b13d_${filename}\\",\\n \\"Dir\\": \\"20211220/131953297274****_4de3db85-4f98-488d-845b-d75bf035b13d\\"\\n}","errorExample":""},{"type":"xml","example":"\\n eyJleHBpcmF0aW9uIjoiMjAaMC0wNy0wMlQxKToyMDoxMS44ODRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsNTI0Mjg4MDBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiMTIxOTU0MTE2MTIxMzA1Ny9PRkZMSU5FX1RSQU5TRkVSLzE1OTM2ODg1MTE4ODMi****\\n 1593688811881\\n 9DFCF6F8-243C-****-8035-4B12FEFD7D48\\n hObpgEXoca42****\\n pNVECGkyL0tl4bKXekV5ErZ****\\n https://********-review.oss-cn-********.aliyuncs.com\\n 20211220/131953297274****_4de3db85-4f98-488d-845b-d75bf035b13d_${filename}\\n 20211220/131953297274****_4de3db85-4f98-488d-845b-d75bf035b13d\\n","errorExample":""}]',
'title' => '根据 SaleID 获取对应的授权策略',
'summary' => '获取“.餐厅”、“.商标”域名对应的授权策略。',
],
'ChangeResourceGroup' => [
'summary' => '修改域名所属的资源组。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户客户端IP',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '接口返回错误信息语言。取值:'."\n"
.'- **zh**:中文。'."\n"
.'- **en**:英文。'."\n"
."\n"
.'默认为**zh**。',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '域名资源ID。',
'type' => 'string',
'required' => true,
'example' => 'S20227H17A561968',
],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '要移动到的资源组ID。'."\n"
."\n"
.'您可以通过[资源管理控制台](https://resourcemanager.console.aliyun.com/resource-groups)查看资源组ID。'."\n",
'type' => 'string',
'required' => true,
'docRequired' => false,
'example' => 'rg-aek2tcx7os7bkmq',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '域名资源类型,固定为“Domain”,不需要填写',
'type' => 'string',
'required' => false,
'example' => 'Domain',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '本次请求调用的唯一ID。',
'type' => 'string',
'example' => '4EA05A10-D4BC-47EA-AD9E-370A46BB4FB9',
],
'Result' => [
'description' => '操作结果。取值:'."\n"
.'- **true**:操作成功。'."\n"
.'- **false**:操作失败。',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EA05A10-D4BC-47EA-AD9E-370A46BB4FB9\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]',
'title' => '修改域名所属资源组',
],
'SaveBatchTaskForReserveDropListDomain' => [
'summary' => '调用SaveBatchTaskForReserveDropListDomain提交批量万网域名预定任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeNodes' => [
'FEATUREdomain0NKSXL',
'FEATUREdomainGE2DE7',
'FEATUREdomainDNBQWJ',
],
],
'parameters' => [
[
'name' => 'ContactTemplateId',
'in' => 'query',
'schema' => [
'description' => '联系人模板ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '123123',
],
],
[
'name' => 'Domains',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '域名列表。',
'type' => 'array',
'items' => [
'description' => '扩展证书绑定的域名。',
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '万网域名示例。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
'Dns1' => [
'description' => '自定义DNS1。'."\n"
."\n"
.'> - 当**OrderActivateParam.N.AliyunDns**取值为**false**时,本参数才可用且必须传入。'."\n"
.'- 请务必确保自定义DNS的正确性,否则可能导致注册失败。',
'type' => 'string',
'required' => false,
'example' => 'ns11.bigwww.com',
],
'Dns2' => [
'description' => '自定义DNS2。'."\n"
."\n"
.'> - 当**AliyunDns**取值为**false**时,本参数才可用且必须传入。'."\n"
.'- 请务必确保自定义DNS的正确性,否则可能导致注册失败。',
'type' => 'string',
'required' => false,
'example' => 'nsb.263idc.net',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 5000,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","errorExample":""},{"type":"xml","example":"\\n B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E\\n 3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\n","errorExample":""}]',
'title' => '提交批量万网域名预定任务',
'description' => '任务执行结果请通过[QueryTaskDetailList](~~QueryTaskDetailList~~)接口查询。',
],
'QueryIntlFixedPriceOrderList' => [
'summary' => '调用QueryIntlFixedPriceOrderList查询国际一口价订单列表。',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain3EBBI7',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'query',
'schema' => [
'description' => '业务ID。',
'type' => 'string',
'required' => false,
'example' => 'T2024061115213700****',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '状态。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '6',
],
],
[
'name' => 'CurrentPage',
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'D6CB3623-4726-4947-AC2B-2C6E673B447C',
],
'Module' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'TotalItemNum' => [
'description' => '总条数。',
'type' => 'integer',
'format' => 'int32',
'example' => '294',
],
'CurrentPageNum' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalPageNum' => [
'description' => '总页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'Data' => [
'description' => '订单列表数据。',
'type' => 'array',
'items' => [
'description' => '单条订单数据。',
'type' => 'object',
'properties' => [
'OrderType' => [
'description' => '订单类型:11,国际一口价。',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'BizId' => [
'description' => '业务ID。',
'type' => 'string',
'example' => 'T2023122019031400****',
],
'UserId' => [
'description' => '用户ID。',
'type' => 'string',
'example' => '545684317770****',
],
'Status' => [
'description' => '订单状态:'."\n"
.'- 5:交易关闭。'."\n"
.'- 6:已支付。'."\n"
.'- 7:待生产。'."\n"
.'- 9:交易完成。',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'Price' => [
'description' => '价格。',
'type' => 'integer',
'format' => 'int64',
'example' => '15000',
],
'Domain' => [
'description' => '域名。',
'type' => 'string',
'example' => 'jslxv.cn',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1715134456000',
],
'UpdateTime' => [
'description' => '更新时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '1715134456000',
],
],
],
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6CB3623-4726-4947-AC2B-2C6E673B447C\\",\\n \\"Module\\": {\\n \\"TotalItemNum\\": 294,\\n \\"CurrentPageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalPageNum\\": 4,\\n \\"Data\\": [\\n {\\n \\"OrderType\\": 11,\\n \\"BizId\\": \\"T2023122019031400****\\",\\n \\"UserId\\": \\"545684317770****\\",\\n \\"Status\\": 6,\\n \\"Price\\": 15000,\\n \\"Domain\\": \\"jslxv.cn\\",\\n \\"CreateTime\\": 1715134456000,\\n \\"UpdateTime\\": 1715134456000\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询国际一口价订单列表',
],
'CheckIntlFixPriceDomainStatus' => [
'summary' => '调用CheckIntlFixPriceDomainStatus校验在售国际一口价域名状态和询价。',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain3EBBI7',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'example' => 'appp16.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
],
'Module' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'Domain' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'Price' => [
'description' => '价格。',
'type' => 'integer',
'format' => 'int64',
'example' => '20.00',
],
'Currency' => [
'description' => '币种。取值:'."\n"
."\n"
.'- RMB:人民币。'."\n"
."\n"
.'- USD:美元。',
'type' => 'string',
'example' => 'USD',
],
'RegDate' => [
'description' => '域名注册日期。',
'type' => 'integer',
'format' => 'int64',
'example' => '1566353497',
],
'DeadDate' => [
'description' => '域名过期日期,购买后用到该时间点后需要域名续费。',
'type' => 'integer',
'format' => 'int64',
'example' => '1567353497',
],
'EndTime' => [
'description' => '域名售卖截止时间,到达该时间后域名不再可售卖。',
'type' => 'integer',
'format' => 'int64',
'example' => '1567353497',
],
'Premium' => [
'description' => '是否为溢价词域名。取值:'."\n"
."\n"
.'- true:是溢价词域名。'."\n"
."\n"
.'- false:不是溢价词域名。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40F46D3D-F4F3-4CCB-AC30-2DD20E32E528\\",\\n \\"Module\\": {\\n \\"Domain\\": \\"example.com\\",\\n \\"Price\\": 20,\\n \\"Currency\\": \\"USD\\",\\n \\"RegDate\\": 1566353497,\\n \\"DeadDate\\": 1567353497,\\n \\"EndTime\\": 1567353497,\\n \\"Premium\\": true\\n }\\n}","type":"json"}]',
'title' => '校验国际一口价在售域名状态和询价',
],
'CreateIntlFixedPriceDomainOrder' => [
'summary' => '调用CreateIntlFixedPriceDomainOrder创建国际一口价订单。',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain3EBBI7',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Domain',
'in' => 'query',
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'example' => 'appp16.com',
],
],
[
'name' => 'ContactId',
'in' => 'query',
'schema' => [
'description' => '联系人ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '13350500',
],
],
[
'name' => 'ExpectedPrice',
'in' => 'query',
'schema' => [
'description' => '期望价格。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '58.00',
],
],
[
'name' => 'AutoPay',
'in' => 'query',
'schema' => [
'description' => '是否为自动支付。取值:'."\n"
."\n"
.'- false(默认值):手动支付。'."\n"
."\n"
.' - true:自动支付。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'E879DC07-38EE-4408-9F33-73B30CD965CD',
],
'Module' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'Domain' => [
'description' => '域名。',
'type' => 'string',
'example' => 'example.com',
],
'OrderNo' => [
'description' => '订单号。',
'type' => 'string',
'example' => '31199295f2074ce895645d386cb2****',
],
'PayPrice' => [
'description' => '成交价格。',
'type' => 'integer',
'format' => 'int64',
'example' => '100.00',
],
'PayUrl' => [
'description' => '支付URL。',
'type' => 'string',
'example' => 'https://',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E879DC07-38EE-4408-9F33-73B30CD965CD\\",\\n \\"Module\\": {\\n \\"Domain\\": \\"example.com\\",\\n \\"OrderNo\\": \\"31199295f2074ce895645d386cb2****\\",\\n \\"PayPrice\\": 100,\\n \\"PayUrl\\": \\"https://\\"\\n }\\n}","type":"json"}]',
'title' => '创建国际一口价订单',
],
'GetIntlFixPriceDomainListUrl' => [
'summary' => '调用GetIntlFixPriceDomainListUrl查询国际一口价在售域名列表。',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain3EBBI7',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ListDate',
'in' => 'query',
'schema' => [
'description' => '文件日期。',
'type' => 'string',
'required' => false,
'example' => '20240809',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'BF014B60-C708-4253-B5F2-3F9B493F398B',
],
'Module' => [
'description' => '返回对象。',
'type' => 'object',
'properties' => [
'DownloadUrl' => [
'description' => '国际一口价在售商品列表下载链接。',
'type' => 'string',
'example' => 'http://intl-fixed-price.oss-cn-zhangjiakou.aliyuncs.com/aliyun_intl_fixed_price_domain_20240827.gz?Expires=1724830838&OSSAccessKeyId=LTAI5tPMAybR4gfSEjdf****&Signature=tb0SPs6tKb9gLKyQ5ibpQnBUuT****',
],
],
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF014B60-C708-4253-B5F2-3F9B493F398B\\",\\n \\"Module\\": {\\n \\"DownloadUrl\\": \\"http://intl-fixed-price.oss-cn-zhangjiakou.aliyuncs.com/aliyun_intl_fixed_price_domain_20240827.gz?Expires=1724830838&OSSAccessKeyId=LTAI5tPMAybR4gfSEjdf****&Signature=tb0SPs6tKb9gLKyQ5ibpQnBUuT****\\"\\n }\\n}","type":"json"}]',
'title' => '获取国际一口价域名列表文件链接',
],
'DomainSpecialBizCancel' => [
'summary' => '取消域名特殊业务流程',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'title' => '业务id',
'description' => '业务id',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '3666'."\n",
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户客户端IP',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO>',
'description' => 'PopResultDTO>',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '096DCF79-A89A-5CED-B7DE-1B04761023B9',
],
'HttpStatusCode' => [
'description' => '直接指定返回的Http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'DynamicCode' => [
'description' => '动态错误Code',
'type' => 'string',
'example' => '-',
],
'DynamicMessage' => [
'description' => '动态错误信息',
'type' => 'string',
'example' => '-',
],
'Synchro' => [
'description' => '是否同步处理',
'type' => 'boolean',
'example' => 'True',
],
'ErrorMsg' => [
'description' => '错误信息',
'type' => 'string',
'example' => '110001',
],
'ErrorCode' => [
'description' => '错误码',
'type' => 'string',
'example' => '参数错误',
],
'Success' => [
'description' => '是否调用成功:true:调用成功。 false:调用失败。',
'type' => 'boolean',
'example' => 'True',
],
'Module' => [
'description' => '返回对象',
'type' => 'any',
'example' => '-',
],
'AllowRetry' => [
'description' => '是否允许重试',
'type' => 'boolean',
'example' => 'False',
],
'ErrorArgs' => [
'description' => '返回错误参数数组',
'type' => 'array',
'items' => [
'description' => '返回错误参数',
'type' => 'any',
'example' => '-',
],
],
'AppName' => [
'description' => '产生errorCode的应用名称',
'type' => 'string',
'example' => 'test-com',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"096DCF79-A89A-5CED-B7DE-1B04761023B9\\",\\n \\"HttpStatusCode\\": 200,\\n \\"DynamicCode\\": \\"-\\",\\n \\"DynamicMessage\\": \\"-\\",\\n \\"Synchro\\": true,\\n \\"ErrorMsg\\": \\"110001\\",\\n \\"ErrorCode\\": \\"参数错误\\",\\n \\"Success\\": true,\\n \\"Module\\": \\"-\\",\\n \\"AllowRetry\\": true,\\n \\"ErrorArgs\\": [\\n \\"-\\"\\n ],\\n \\"AppName\\": \\"test-com\\"\\n}","type":"json"}]',
'title' => '取消业务流程',
],
'SubmitDomainSpecialBizCredentials' => [
'summary' => '域名特殊业务提交资料',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'description' => '业务ID',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '219',
],
],
[
'name' => 'Credentials',
'in' => 'formData',
'schema' => [
'description' => '证件信息',
'type' => 'string',
'required' => false,
'example' => '[{"credentialType":"SHSQB",""credentialUrl":"11212121/1212d**/sqb.jpg"},{"credentialType":"SFZZM",""credentialUrl":"11212121/1212d**/sfzzm.jpg"}]',
],
],
[
'name' => 'Extend',
'in' => 'formData',
'schema' => [
'description' => '扩展信息',
'type' => 'string',
'required' => false,
'example' => '{\\"addTransferLock\\":true}',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户客户端IP',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO>',
'description' => 'PopResultDTO>',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => 'A83E1D74-E46B-505C-947A-8C6B7E41C011'."\n",
],
'HttpStatusCode' => [
'description' => '直接指定返回的Http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200'."\n",
],
'DynamicCode' => [
'description' => '动态错误Code',
'type' => 'string',
'example' => '-',
],
'DynamicMessage' => [
'description' => '动态错误信息',
'type' => 'string',
'example' => '-',
],
'Synchro' => [
'description' => '是否同步处理',
'type' => 'boolean',
'example' => 'True',
],
'ErrorMsg' => [
'description' => '错误信息',
'type' => 'string',
'example' => '110001',
],
'ErrorCode' => [
'description' => '错误码',
'type' => 'string',
'example' => '参数错误',
],
'Success' => [
'description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'True',
],
'Module' => [
'description' => '返回对象',
'type' => 'any',
'example' => '-',
],
'AllowRetry' => [
'description' => '是否允许重试',
'type' => 'boolean',
'example' => 'False',
],
'ErrorArgs' => [
'description' => '返回错误参数数组',
'type' => 'array',
'items' => [
'description' => '返回错误参数',
'type' => 'any',
'example' => '-',
],
],
'AppName' => [
'description' => '产生errorCode的应用名称',
'type' => 'string',
'example' => 'test-com'."\n",
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A83E1D74-E46B-505C-947A-8C6B7E41C011\\\\n\\",\\n \\"HttpStatusCode\\": 200,\\n \\"DynamicCode\\": \\"-\\",\\n \\"DynamicMessage\\": \\"-\\",\\n \\"Synchro\\": true,\\n \\"ErrorMsg\\": \\"110001\\",\\n \\"ErrorCode\\": \\"参数错误\\",\\n \\"Success\\": true,\\n \\"Module\\": \\"-\\",\\n \\"AllowRetry\\": true,\\n \\"ErrorArgs\\": [\\n \\"-\\"\\n ],\\n \\"AppName\\": \\"test-com\\\\n\\"\\n}","type":"json"}]',
'title' => '提交证件信息',
],
'QueryDomainSpecialBizInfoByDomain' => [
'summary' => '通过域名查询域名特殊业务详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'formData',
'schema' => [
'title' => '域名',
'description' => '域名',
'type' => 'string',
'required' => true,
'example' => 'test003.cn',
],
],
[
'name' => 'BizType',
'in' => 'formData',
'schema' => [
'title' => '业务类型',
'description' => '业务类型',
'type' => 'string',
'required' => true,
'example' => 'govRegister',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户客户端IP',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO',
'description' => 'PopResultDTO',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => '97663DFF-D24D-55AE-A577-6CC5AF20B732',
],
'HttpStatusCode' => [
'description' => '直接指定返回的Http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'DynamicCode' => [
'description' => '动态错误Code',
'type' => 'string',
'example' => '-',
],
'DynamicMessage' => [
'description' => '动态错误信息',
'type' => 'string',
'example' => '-',
],
'Synchro' => [
'description' => '是否同步处理',
'type' => 'boolean',
'example' => 'true',
],
'ErrorMsg' => [
'description' => '错误信息',
'type' => 'string',
'example' => '110001'."\n",
],
'ErrorCode' => [
'description' => '错误码',
'type' => 'string',
'example' => '参数错误',
],
'Success' => [
'description' => '是否调用成功:true:调用成功。 false:调用失败。',
'type' => 'boolean',
'example' => 'True',
],
'Module' => [
'description' => '返回对象',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '主键',
'description' => '主键',
'type' => 'integer',
'format' => 'int64',
'example' => '34083',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2023-03-21 15:10:04.0'."\n",
],
'GmtModified' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2023-03-21 15:10:04.0'."\n",
],
'BizName' => [
'title' => '业务名称',
'description' => '业务名称',
'type' => 'string',
'example' => 'GOV.CN域名注册(test003.cn)'."\n",
],
'BizNo' => [
'title' => '业务编号',
'description' => '业务编号',
'type' => 'string',
'example' => 'A83E1D74-E46B-505C-947A-8C6B7E41C012'."\n",
],
'DomainName' => [
'title' => '域名',
'description' => '域名',
'type' => 'string',
'example' => 'test003.cn'."\n",
],
'SaleId' => [
'title' => '实例ID',
'description' => '实例ID',
'type' => 'string',
'example' => 'S20172315BJ37809'."\n",
],
'UserId' => [
'title' => '用户ID',
'description' => '用户ID',
'type' => 'string',
'example' => '121000000****'."\n",
],
'ProductId' => [
'title' => '产品id',
'description' => '产品id',
'type' => 'string',
'example' => '1',
],
'BizType' => [
'title' => '业务类型',
'description' => '业务类型',
'type' => 'string',
'example' => 'govRegister'."\n",
],
'BizStatus' => [
'title' => '业务状态',
'description' => '业务状态',
'type' => 'string',
'example' => 'REGISTRANT_VSP_AUDIT_SUCCESS'."\n",
],
'Status' => [
'title' => '业务状态(用户前端使用)',
'description' => '业务状态(用户前端使用)',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'StatusDesc' => [
'title' => '业务状态描述(用户前端使用)',
'description' => '业务状态描述(用户前端使用)',
'type' => 'string',
'example' => '信息审核成功'."\n",
],
'AuditMsg' => [
'title' => '审核信息',
'description' => '审核信息',
'type' => 'string',
'example' => '审核通过'."\n",
],
'OrderId' => [
'title' => '订单id',
'description' => '订单id',
'type' => 'string',
'example' => '123',
],
'UpdateTime' => [
'title' => '更新时间',
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '2020-11-17 18:11:15'."\n",
],
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '2023-01-17 11:31:10'."\n",
],
'DomainSpecialBizContact' => [
'title' => '联系人信息',
'description' => '联系人信息',
'type' => 'object',
'properties' => [
'BizId' => [
'title' => '业务id',
'description' => '业务id',
'type' => 'integer',
'format' => 'int64',
'example' => '258'."\n",
],
'RegType' => [
'title' => '类型:1-个人 ,2-企业',
'description' => '类型:1-个人 ,2-企业',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CCompany' => [
'title' => '组织名称',
'description' => '组织名称',
'type' => 'string',
'example' => '河北易迪管道制造有限公司'."\n",
],
'ECompany' => [
'title' => '组织名称(英文)',
'description' => '组织名称(英文)',
'type' => 'string',
'example' => 'hebeihuiheguandaozhizaoyouxiangongsi'."\n",
],
'CName' => [
'title' => '联系人姓名',
'description' => '联系人姓名',
'type' => 'string',
'example' => '佟大伟'."\n",
],
'EName' => [
'title' => '联系人姓名(英文)',
'description' => '联系人姓名(英文)',
'type' => 'string',
'example' => 'tong da wei',
],
'CCountry' => [
'title' => '国家代码',
'description' => '国家代码',
'type' => 'string',
'example' => 'CN',
],
'CProvince' => [
'title' => '省份',
'description' => '省份',
'type' => 'string',
'example' => '辽宁',
],
'EProvince' => [
'title' => '省份(英文)',
'description' => '省份(英文)',
'type' => 'string',
'example' => 'liao ning',
],
'CCity' => [
'title' => '城市',
'description' => '城市',
'type' => 'string',
'example' => '鞍山市',
],
'ECity' => [
'title' => '城市(英文)',
'description' => '城市(英文)',
'type' => 'string',
'example' => 'an shan Shi',
],
'CVenu' => [
'title' => '地址',
'description' => '地址',
'type' => 'string',
'example' => '铁西区新开街59栋1单元4号',
],
'EVenu' => [
'title' => '地址(英文)',
'description' => '地址(英文)',
'type' => 'string',
'example' => 'tie xi qu xin kai jie 59-4 hao',
],
'Postalcode' => [
'title' => '邮编',
'description' => '邮编',
'type' => 'string',
'example' => '100000'."\n",
],
'Email' => [
'title' => '电子邮箱',
'description' => '电子邮箱',
'type' => 'string',
'example' => 'username@example.com'."\n",
],
'TelArea' => [
'title' => '电话国家代码',
'description' => '电话国家代码',
'type' => 'string',
'example' => '86',
],
'TelMain' => [
'title' => '区号固定电话或手机号码',
'description' => '区号固定电话或手机号码',
'type' => 'string',
'example' => '16604121234',
],
'TelExt' => [
'title' => '电话分机号',
'description' => '电话分机号',
'type' => 'string',
'example' => '2756',
],
'FaxArea' => [
'title' => '传真国家代码',
'description' => '传真国家代码',
'type' => 'string',
'example' => '86'."\n",
],
'FaxMain' => [
'title' => '区号传真号或手机号码',
'description' => '区号传真号或手机号码',
'type' => 'string',
'example' => '16604121234'."\n",
],
'FaxExt' => [
'title' => '传真分机号',
'description' => '传真分机号',
'type' => 'string',
'example' => '61284565'."\n",
],
'Mobile' => [
'title' => '手机号码',
'description' => '手机号码',
'type' => 'string',
'example' => '156********'."\n",
],
'Extend' => [
'title' => '扩展信息',
'description' => '扩展信息',
'type' => 'string',
'example' => '-',
],
'VspContactId' => [
'title' => 'vsp联系人id',
'description' => 'vsp联系人id',
'type' => 'string',
'example' => '121000001****'."\n",
],
'RegistrantId' => [
'title' => '持有者id',
'description' => '持有者id',
'type' => 'string',
'example' => '121000002****'."\n",
],
],
],
'DomainSpecialBizCredentials' => [
'title' => '证件信息',
'description' => '证件信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DomainName' => [
'title' => '域名',
'description' => '域名',
'type' => 'string',
'example' => 'test003.cn'."\n",
],
'SaleId' => [
'title' => '实例ID',
'description' => '实例ID',
'type' => 'string',
'example' => 'S20172315BJ37809'."\n",
],
'BizId' => [
'title' => '关联流程ID',
'description' => '关联流程ID',
'type' => 'integer',
'format' => 'int64',
'example' => 'T20220831150014000001'."\n",
],
'CredentialNo' => [
'title' => '证件号',
'description' => '证件号',
'type' => 'string',
'example' => '4111111111111110**'."\n",
],
'CredentialType' => [
'title' => '证件类型',
'description' => '证件类型',
'type' => 'string',
'example' => 'SFZ'."\n",
],
'CredentialUrl' => [
'title' => '证件url',
'description' => '证件url',
'type' => 'string',
'example' => 'http://test.oss-cn-hangzhou.aliyuncs.com/20170522/1219541161213057_070445190.jpg',
],
'HolderCert' => [
'title' => '是否持有者证件',
'description' => '是否持有者证件',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
'AllowRetry' => [
'description' => '是否允许重试',
'type' => 'boolean',
'example' => 'False',
],
'ErrorArgs' => [
'description' => '返回错误参数数组',
'type' => 'array',
'items' => [
'description' => '返回错误参数',
'type' => 'any',
'example' => '-',
],
],
'AppName' => [
'description' => '产生errorCode的应用名称',
'type' => 'string',
'example' => 'test-com'."\n",
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"97663DFF-D24D-55AE-A577-6CC5AF20B732\\",\\n \\"HttpStatusCode\\": 200,\\n \\"DynamicCode\\": \\"-\\",\\n \\"DynamicMessage\\": \\"-\\",\\n \\"Synchro\\": true,\\n \\"ErrorMsg\\": \\"110001\\\\n\\",\\n \\"ErrorCode\\": \\"参数错误\\",\\n \\"Success\\": true,\\n \\"Module\\": {\\n \\"Id\\": 34083,\\n \\"GmtCreate\\": \\"2023-03-21 15:10:04.0\\\\n\\",\\n \\"GmtModified\\": \\"2023-03-21 15:10:04.0\\\\n\\",\\n \\"BizName\\": \\"GOV.CN域名注册(test003.cn)\\\\n\\",\\n \\"BizNo\\": \\"A83E1D74-E46B-505C-947A-8C6B7E41C012\\\\n\\",\\n \\"DomainName\\": \\"test003.cn\\\\n\\",\\n \\"SaleId\\": \\"S20172315BJ37809\\\\n\\",\\n \\"UserId\\": \\"121000000****\\\\n\\",\\n \\"ProductId\\": \\"1\\",\\n \\"BizType\\": \\"govRegister\\\\n\\",\\n \\"BizStatus\\": \\"REGISTRANT_VSP_AUDIT_SUCCESS\\\\n\\",\\n \\"Status\\": 1,\\n \\"StatusDesc\\": \\"信息审核成功\\\\n\\",\\n \\"AuditMsg\\": \\"审核通过\\\\n\\",\\n \\"OrderId\\": \\"123\\",\\n \\"UpdateTime\\": 0,\\n \\"CreateTime\\": 0,\\n \\"DomainSpecialBizContact\\": {\\n \\"BizId\\": 258,\\n \\"RegType\\": 1,\\n \\"CCompany\\": \\"河北易迪管道制造有限公司\\\\n\\",\\n \\"ECompany\\": \\"hebeihuiheguandaozhizaoyouxiangongsi\\\\n\\",\\n \\"CName\\": \\"佟大伟\\\\n\\",\\n \\"EName\\": \\"tong da wei\\",\\n \\"CCountry\\": \\"CN\\",\\n \\"CProvince\\": \\"辽宁\\",\\n \\"EProvince\\": \\"liao ning\\",\\n \\"CCity\\": \\"鞍山市\\",\\n \\"ECity\\": \\"an shan Shi\\",\\n \\"CVenu\\": \\"铁西区新开街59栋1单元4号\\",\\n \\"EVenu\\": \\"tie xi qu xin kai jie 59-4 hao\\",\\n \\"Postalcode\\": \\"100000\\\\n\\",\\n \\"Email\\": \\"username@example.com\\\\n\\",\\n \\"TelArea\\": \\"86\\",\\n \\"TelMain\\": \\"16604121234\\",\\n \\"TelExt\\": \\"2756\\",\\n \\"FaxArea\\": \\"86\\\\n\\",\\n \\"FaxMain\\": \\"16604121234\\\\n\\",\\n \\"FaxExt\\": \\"61284565\\\\n\\",\\n \\"Mobile\\": \\"156********\\\\n\\",\\n \\"Extend\\": \\"-\\",\\n \\"VspContactId\\": \\"121000001****\\\\n\\",\\n \\"RegistrantId\\": \\"121000002****\\\\n\\"\\n },\\n \\"DomainSpecialBizCredentials\\": [\\n {\\n \\"DomainName\\": \\"test003.cn\\\\n\\",\\n \\"SaleId\\": \\"S20172315BJ37809\\\\n\\",\\n \\"BizId\\": 0,\\n \\"CredentialNo\\": \\"4111111111111110**\\\\n\\",\\n \\"CredentialType\\": \\"SFZ\\\\n\\",\\n \\"CredentialUrl\\": \\"http://test.oss-cn-hangzhou.aliyuncs.com/20170522/1219541161213057_070445190.jpg\\",\\n \\"HolderCert\\": 1\\n }\\n ]\\n },\\n \\"AllowRetry\\": true,\\n \\"ErrorArgs\\": [\\n \\"-\\"\\n ],\\n \\"AppName\\": \\"test-com\\\\n\\"\\n}","type":"json"}]',
'title' => '查询最新特殊域名业务',
],
'QueryDomainSpecialBizDetail' => [
'summary' => '查询域名特殊业务详情',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'title' => '业务id',
'description' => '业务id',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '用户客户端IP。',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO',
'description' => 'PopResultDTO',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '唯一请求识别码',
'type' => 'string',
'example' => 'A83E1D74-E46B-505C-947A-8C6B7E41C011',
],
'HttpStatusCode' => [
'description' => '直接指定返回的Http状态码',
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'DynamicCode' => [
'description' => '动态错误Code',
'type' => 'string',
'example' => '-',
],
'DynamicMessage' => [
'description' => '动态错误信息',
'type' => 'string',
'example' => '-',
],
'Synchro' => [
'description' => '是否同步处理',
'type' => 'boolean',
'example' => 'true',
],
'ErrorMsg' => [
'description' => '错误信息',
'type' => 'string',
'example' => '110001',
],
'ErrorCode' => [
'description' => '错误码',
'type' => 'string',
'example' => '参数错误',
],
'Success' => [
'description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。',
'type' => 'boolean',
'example' => 'True',
],
'Module' => [
'description' => '返回对象',
'type' => 'object',
'properties' => [
'Id' => [
'title' => '主键',
'description' => '主键',
'type' => 'integer',
'format' => 'int64',
'example' => '34083',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'string',
'example' => '2023-03-21 15:10:04.0',
],
'GmtModified' => [
'title' => '修改时间',
'description' => '修改时间',
'type' => 'string',
'example' => '2023-03-21 15:10:04.0',
],
'BizName' => [
'title' => '业务名称',
'description' => '业务名称',
'type' => 'string',
'example' => 'GOV.CN域名注册(test003.cn)',
],
'BizNo' => [
'title' => '业务编号',
'description' => '业务编号',
'type' => 'string',
'example' => 'A83E1D74-E46B-505C-947A-8C6B7E41C012',
],
'DomainName' => [
'title' => '域名',
'description' => '域名',
'type' => 'string',
'example' => 'test003.cn',
],
'SaleId' => [
'title' => '实例ID',
'description' => '实例ID',
'type' => 'string',
'example' => 'S20172315BJ37809',
],
'UserId' => [
'title' => '用户ID',
'description' => '用户ID',
'type' => 'string',
'example' => '121000000****',
],
'ProductId' => [
'title' => '产品id',
'description' => '产品id',
'type' => 'string',
'example' => '1',
],
'BizType' => [
'title' => '业务类型',
'description' => '业务类型',
'type' => 'string',
'example' => 'govRegister',
],
'BizStatus' => [
'title' => '业务状态',
'description' => '业务状态',
'type' => 'string',
'example' => 'REGISTRANT_VSP_AUDIT_SUCCESS',
],
'Status' => [
'title' => '业务状态(用户前端使用)',
'description' => '业务状态(用户前端使用)',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'StatusDesc' => [
'title' => '业务状态描述(用户前端使用)',
'description' => '业务状态描述(用户前端使用)',
'type' => 'string',
'example' => '信息审核成功',
],
'AuditMsg' => [
'title' => '审核信息',
'description' => '审核信息',
'type' => 'string',
'example' => '审核通过',
],
'OrderId' => [
'title' => '订单id',
'description' => '订单id',
'type' => 'string',
'example' => '123',
],
'UpdateTime' => [
'title' => '更新时间',
'description' => '更新时间',
'type' => 'integer',
'format' => 'int64',
'example' => '2020-11-17 18:11:15',
],
'CreateTime' => [
'title' => '创建时间',
'description' => '创建时间',
'type' => 'integer',
'format' => 'int64',
'example' => '2023-01-17 11:31:10',
],
'DomainSpecialBizContact' => [
'title' => '联系人信息',
'description' => '联系人信息',
'type' => 'object',
'properties' => [
'BizId' => [
'title' => '业务id',
'description' => '业务id',
'type' => 'integer',
'format' => 'int64',
'example' => '258',
],
'RegType' => [
'title' => '类型:1-个人 ,2-企业',
'description' => '类型:1-个人 ,2-企业',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CCompany' => [
'title' => '组织名称',
'description' => '组织名称',
'type' => 'string',
'example' => '河北易迪管道制造有限公司',
],
'ECompany' => [
'title' => '组织名称(英文)',
'description' => '组织名称(英文)',
'type' => 'string',
'example' => 'hebeihuiheguandaozhizaoyouxiangongsi',
],
'CName' => [
'title' => '联系人姓名',
'description' => '联系人姓名',
'type' => 'string',
'example' => '佟大伟',
],
'EName' => [
'title' => '联系人姓名(英文)',
'description' => '联系人姓名(英文)',
'type' => 'string',
'example' => 'tong da wei',
],
'CCountry' => [
'title' => '国家代码',
'description' => '国家代码',
'type' => 'string',
'example' => 'CN',
],
'CProvince' => [
'title' => '省份',
'description' => '省份',
'type' => 'string',
'example' => '辽宁',
],
'EProvince' => [
'title' => '省份(英文)',
'description' => '省份(英文)',
'type' => 'string',
'example' => 'liao ning',
],
'CCity' => [
'title' => '城市',
'description' => '城市',
'type' => 'string',
'example' => '鞍山市',
],
'ECity' => [
'title' => '城市(英文)',
'description' => '城市(英文)',
'type' => 'string',
'example' => 'an shan Shi',
],
'CVenu' => [
'title' => '地址',
'description' => '地址',
'type' => 'string',
'example' => '铁西区新开街59-4号',
],
'EVenu' => [
'title' => '地址(英文)',
'description' => '地址(英文)',
'type' => 'string',
'example' => 'tie xi qu xin kai jie 59-4 hao',
],
'Postalcode' => [
'title' => '邮编',
'description' => '邮编',
'type' => 'string',
'example' => '100000',
],
'Email' => [
'title' => '电子邮箱',
'description' => '电子邮箱',
'type' => 'string',
'example' => 'username@example.com',
],
'TelArea' => [
'title' => '电话国家代码',
'description' => '电话国家代码',
'type' => 'string',
'example' => '86',
],
'TelMain' => [
'title' => '区号固定电话或手机号码',
'description' => '区号固定电话或手机号码',
'type' => 'string',
'example' => '16604121234',
],
'TelExt' => [
'title' => '电话分机号',
'description' => '电话分机号',
'type' => 'string',
'example' => '61284565',
],
'FaxArea' => [
'title' => '传真国家代码',
'description' => '传真国家代码',
'type' => 'string',
'example' => '86',
],
'FaxMain' => [
'title' => '区号传真号或手机号码',
'description' => '区号传真号或手机号码',
'type' => 'string',
'example' => '16604121234',
],
'FaxExt' => [
'title' => '传真分机号',
'description' => '传真分机号',
'type' => 'string',
'example' => '61284565',
],
'Mobile' => [
'title' => '手机号码',
'description' => '手机号码',
'type' => 'string',
'example' => '156********',
],
'Extend' => [
'title' => '扩展信息',
'description' => '扩展信息',
'type' => 'string',
'example' => '-',
],
'VspContactId' => [
'title' => 'vsp联系人id',
'description' => 'vsp联系人id',
'type' => 'string',
'example' => '121000001****',
],
'RegistrantId' => [
'title' => '持有者id',
'description' => '持有者id',
'type' => 'string',
'example' => '121000002****',
],
],
],
'DomainSpecialBizCredentials' => [
'title' => '证件信息',
'description' => '证件信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DomainName' => [
'title' => '域名',
'description' => '域名',
'type' => 'string',
'example' => 'test003.cn',
],
'SaleId' => [
'title' => '实例ID',
'description' => '实例ID',
'type' => 'string',
'example' => 'S20172315BJ37809',
],
'BizId' => [
'title' => '关联流程ID',
'description' => '关联流程ID',
'type' => 'integer',
'format' => 'int64',
'example' => 'T20220831150014000001',
],
'CredentialNo' => [
'title' => '证件号',
'description' => '证件号',
'type' => 'string',
'example' => '4111111111111110**',
],
'CredentialType' => [
'title' => '证件类型',
'description' => '证件类型',
'type' => 'string',
'example' => 'SFZ',
],
'CredentialUrl' => [
'title' => '证件url',
'description' => '证件url',
'type' => 'string',
'example' => 'http://test.oss-cn-hangzhou.aliyuncs.com/20170522/1219541161213057_070445190.jpg',
],
'HolderCert' => [
'title' => '是否持有者证件',
'description' => '是否持有者证件',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'DomainSpecialOrderResult' => [
'description' => '订单信息',
'type' => 'object',
'properties' => [
'SaleId' => [
'description' => '实例ID',
'type' => 'string',
'example' => 'S201601063418719',
],
'OrderId' => [
'description' => '订单号',
'type' => 'string',
'example' => 'S201601060123456',
],
'SubOrderId' => [
'description' => '子订单号',
'type' => 'string',
'example' => 'S201601061234567',
],
'ActionType' => [
'description' => '费用类型',
'type' => 'string',
'example' => 'activate',
],
'OrderAmount' => [
'description' => '订单金额',
'type' => 'number',
'format' => 'double',
'example' => '0.0',
],
'OrderCurrency' => [
'description' => '币种',
'type' => 'string',
'example' => 'CNY',
],
'OrderTime' => [
'description' => '下单时间',
'type' => 'string',
'example' => '2023-09-19T14:28Z',
],
'OrderYear' => [
'description' => '年限',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'OrderStatus' => [
'description' => '订单状态',
'type' => 'string',
'example' => 'ORDER_WAIT_PAY',
],
],
],
],
],
'AllowRetry' => [
'description' => '是否允许重试',
'type' => 'boolean',
'example' => 'False',
],
'ErrorArgs' => [
'description' => '返回错误参数数组',
'type' => 'array',
'items' => [
'description' => '返回错误参数',
'type' => 'any',
'example' => '-',
],
],
'AppName' => [
'description' => '产生errorCode的应用名称',
'type' => 'string',
'example' => 'test-com',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A83E1D74-E46B-505C-947A-8C6B7E41C011\\",\\n \\"HttpStatusCode\\": 200,\\n \\"DynamicCode\\": \\"-\\",\\n \\"DynamicMessage\\": \\"-\\",\\n \\"Synchro\\": true,\\n \\"ErrorMsg\\": \\"110001\\",\\n \\"ErrorCode\\": \\"参数错误\\",\\n \\"Success\\": true,\\n \\"Module\\": {\\n \\"Id\\": 34083,\\n \\"GmtCreate\\": \\"2023-03-21 15:10:04.0\\",\\n \\"GmtModified\\": \\"2023-03-21 15:10:04.0\\",\\n \\"BizName\\": \\"GOV.CN域名注册(test003.cn)\\",\\n \\"BizNo\\": \\"A83E1D74-E46B-505C-947A-8C6B7E41C012\\",\\n \\"DomainName\\": \\"test003.cn\\",\\n \\"SaleId\\": \\"S20172315BJ37809\\",\\n \\"UserId\\": \\"121000000****\\",\\n \\"ProductId\\": \\"1\\",\\n \\"BizType\\": \\"govRegister\\",\\n \\"BizStatus\\": \\"REGISTRANT_VSP_AUDIT_SUCCESS\\",\\n \\"Status\\": 1,\\n \\"StatusDesc\\": \\"信息审核成功\\",\\n \\"AuditMsg\\": \\"审核通过\\",\\n \\"OrderId\\": \\"123\\",\\n \\"UpdateTime\\": 0,\\n \\"CreateTime\\": 0,\\n \\"DomainSpecialBizContact\\": {\\n \\"BizId\\": 258,\\n \\"RegType\\": 1,\\n \\"CCompany\\": \\"河北易迪管道制造有限公司\\",\\n \\"ECompany\\": \\"hebeihuiheguandaozhizaoyouxiangongsi\\",\\n \\"CName\\": \\"佟大伟\\",\\n \\"EName\\": \\"tong da wei\\",\\n \\"CCountry\\": \\"CN\\",\\n \\"CProvince\\": \\"辽宁\\",\\n \\"EProvince\\": \\"liao ning\\",\\n \\"CCity\\": \\"鞍山市\\",\\n \\"ECity\\": \\"an shan Shi\\",\\n \\"CVenu\\": \\"铁西区新开街59-4号\\",\\n \\"EVenu\\": \\"tie xi qu xin kai jie 59-4 hao\\",\\n \\"Postalcode\\": \\"100000\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"TelArea\\": \\"86\\",\\n \\"TelMain\\": \\"16604121234\\",\\n \\"TelExt\\": \\"61284565\\",\\n \\"FaxArea\\": \\"86\\",\\n \\"FaxMain\\": \\"16604121234\\",\\n \\"FaxExt\\": \\"61284565\\",\\n \\"Mobile\\": \\"156********\\",\\n \\"Extend\\": \\"-\\",\\n \\"VspContactId\\": \\"121000001****\\",\\n \\"RegistrantId\\": \\"121000002****\\"\\n },\\n \\"DomainSpecialBizCredentials\\": [\\n {\\n \\"DomainName\\": \\"test003.cn\\",\\n \\"SaleId\\": \\"S20172315BJ37809\\",\\n \\"BizId\\": 0,\\n \\"CredentialNo\\": \\"4111111111111110**\\",\\n \\"CredentialType\\": \\"SFZ\\",\\n \\"CredentialUrl\\": \\"http://test.oss-cn-hangzhou.aliyuncs.com/20170522/1219541161213057_070445190.jpg\\",\\n \\"HolderCert\\": 1\\n }\\n ],\\n \\"DomainSpecialOrderResult\\": {\\n \\"SaleId\\": \\"S201601063418719\\",\\n \\"OrderId\\": \\"S201601060123456\\",\\n \\"SubOrderId\\": \\"S201601061234567\\",\\n \\"ActionType\\": \\"activate\\",\\n \\"OrderAmount\\": 0,\\n \\"OrderCurrency\\": \\"CNY\\",\\n \\"OrderTime\\": \\"2023-09-19T14:28Z\\",\\n \\"OrderYear\\": 1,\\n \\"OrderStatus\\": \\"ORDER_WAIT_PAY\\"\\n }\\n },\\n \\"AllowRetry\\": true,\\n \\"ErrorArgs\\": [\\n \\"-\\"\\n ],\\n \\"AppName\\": \\"test-com\\"\\n}","type":"json"}]',
'title' => '查询特殊域名业务详情',
],
'SaveBatchTaskForTransferOutByAuthorizationCode' => [
'summary' => '调用SaveBatchTaskForTransferOutByAuthorizationCode提交基于转移码的批量转出任务。',
'path' => '',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain9WEVJX',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TransferOutParamList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '转出参数列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AuthorizationCode' => [
'description' => '转移码。',
'type' => 'string',
'required' => false,
'example' => 'Test2o#Lck',
],
'DomainName' => [
'description' => '域名。',
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
'required' => false,
],
'required' => true,
'example' => 'SaveBatchTaskForTransferOutByAuthorizationCode',
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'errorCodes' => [],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","type":"json"}]',
'title' => '基于转移码的批量转出任务提交',
'description' => '任务执行结果请通过查询任务详情QueryTaskDetailList接口来查询。',
],
'SaveSingleTaskForTransferOutByAuthorizationCode' => [
'summary' => '调用SaveSingleTaskForTransferOutByAuthorizationCode提交基于转移码的单个转出任务。',
'path' => '',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREdomain9WEVJX',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '域名。',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'AuthorizationCode',
'in' => 'query',
'schema' => [
'description' => '转移码。',
'type' => 'string',
'required' => true,
'example' => 'Test2o#Lck',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '唯一请求识别码。',
'type' => 'string',
'example' => 'C560A803-B975-481D-A66B-A4395EA863A1',
],
'TaskNo' => [
'description' => '任务编号。',
'type' => 'string',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
],
],
],
],
],
'errorCodes' => [],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C560A803-B975-481D-A66B-A4395EA863A1\\",\\n \\"TaskNo\\": \\"3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8\\"\\n}","type":"json"}]',
'title' => '基于转移码的单个转出任务提交',
'description' => '任务执行结果请通过查询任务详情QueryTaskDetailList接口来查询。',
],
],
'endpoints' => [
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'domain.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'domain-intl.aliyuncs.com',
],
],
];