'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Domain',
'version' => '2018-01-29',
],
'directories' => [
[
'id' => 169607,
'title' => 'Domain Name Registration, Renewal and Redemption',
'type' => 'directory',
'children' => [
'SaveSingleTaskForCreatingOrderActivate',
'SaveBatchTaskForCreatingOrderActivate',
'SaveBatchTaskForCreatingOrderRenew',
'SaveSingleTaskForCreatingOrderRenew',
'SaveSingleTaskForCreatingOrderRedeem',
'SaveBatchTaskForCreatingOrderRedeem',
'CheckDomain',
'FuzzyMatchDomainSensitiveWord',
'BatchFuzzyMatchDomainSensitiveWord',
'SetupDomainAutoRenew',
],
],
[
'id' => 60935,
'title' => 'Template Management',
'type' => 'directory',
'children' => [
'SaveRegistrantProfile',
'DeleteRegistrantProfile',
'DeleteContactTemplates',
'RegistrantProfileRealNameVerification',
'SetDefaultRegistrantProfile',
'QueryDomainAdminDivision',
'QueryFailReasonForRegistrantProfileRealNameVerification',
'VerifyContactField',
'QueryRegistrantProfiles',
'QueryRegistrantProfileRealNameVerificationInfo',
],
],
[
'id' => 60921,
'title' => 'real name authentication',
'type' => 'directory',
'children' => [
'SaveTaskForSubmittingDomainRealNameVerificationByIdentityCredential',
'SaveTaskForSubmittingDomainRealNameVerificationByRegistrantProfileID',
'CancelDomainVerification',
'QueryDomainRealNameVerificationInfo',
'QueryFailReasonForDomainRealNameVerification',
],
],
[
'id' => 169608,
'title' => 'Mailbox Validation',
'type' => 'directory',
'children' => [
'DeleteEmailVerification',
'VerifyEmail',
'ResendEmailVerification',
'SubmitEmailVerification',
'QueryEmailVerification',
'ListEmailVerification',
],
],
[
'id' => 169609,
'title' => 'Domain name transfer and information modification',
'type' => 'directory',
'children' => [
'SaveSingleTaskForUpdateProhibitionLock',
'SaveBatchTaskForUpdateProhibitionLock',
'SaveTaskForUpdatingRegistrantInfoByRegistrantProfileID',
'SaveTaskForUpdatingRegistrantInfoByIdentityCredential',
'SaveSingleTaskForUpdatingContactInfo',
'SaveBatchTaskForUpdatingContactInfoByNewContact',
'SaveBatchTaskForUpdatingContactInfoByRegistrantProfileId',
],
],
[
'id' => 60926,
'title' => 'Domain Name Transfer Management',
'type' => 'directory',
'children' => [
'SaveBatchTaskForCreatingOrderTransfer',
'SaveSingleTaskForCreatingOrderTransfer',
'SaveSingleTaskForCancelingTransferIn',
'SaveSingleTaskForCancelingTransferOut',
'TransferInReenterTransferAuthorizationCode',
'TransferInResendMailToken',
'TransferInRefetchWhoisEmail',
'TransferInCheckMailToken',
'SaveSingleTaskForQueryingTransferAuthorizationCode',
'SaveBatchTaskForTransferProhibitionLock',
'SaveSingleTaskForTransferProhibitionLock',
'ConfirmTransferInEmail',
'QueryTransferInByInstanceId',
'QueryTransferInList',
'QueryTransferOutInfo',
'CheckTransferInFeasibility',
'SaveSingleTaskForApplyQuickTransferOutOpenly',
'SaveBatchTaskForApplyQuickTransferOutOpenly',
],
],
[
'id' => 169613,
'title' => 'Task Management',
'type' => 'directory',
'children' => [
'CancelTask',
'AcknowledgeTaskResult',
'QueryTaskDetailHistory',
'PollTaskResult',
'QueryTaskList',
'QueryTaskInfoHistory',
'QueryTaskDetailList',
],
],
[
'id' => 60915,
'title' => 'domain name information query',
'type' => 'directory',
'children' => [
'QueryDomainByDomainName',
'QueryContactInfo',
'QueryDomainByInstanceId',
'QueryDomainList',
'ScrollDomainList',
'QueryDomainSuffix',
'QueryAdvancedDomainList',
'LookupTmchNotice',
'CheckDomainSunriseClaim',
'QueryArtExtension',
],
],
[
'id' => 169614,
'title' => 'DNS Management',
'type' => 'directory',
'children' => [
'SaveSingleTaskForCreatingDnsHost',
'SaveSingleTaskForAddingDSRecord',
'SaveSingleTaskForDeletingDnsHost',
'SaveSingleTaskForDeletingDSRecord',
'SaveSingleTaskForSynchronizingDnsHost',
'SaveSingleTaskForSynchronizingDSRecord',
'SaveSingleTaskForModifyingDnsHost',
'SaveSingleTaskForModifyingDSRecord',
'SaveBatchTaskForModifyingDomainDns',
'QueryDnsHost',
'QueryDSRecord',
],
],
[
'id' => 169615,
'title' => 'Group Management',
'type' => 'directory',
'children' => [
'DeleteDomainGroup',
'UpdateDomainToDomainGroup',
'SaveDomainGroup',
'QueryDomainGroupList',
],
],
[
'id' => 165272,
'title' => 'Registry lock management',
'type' => 'directory',
'children' => [
'QueryServerLock',
'CheckProcessingServerLockApply',
'CheckMaxYearOfServerLock',
'ListServerLock',
],
],
[
'id' => 60943,
'title' => '. Restaurant/. Trademark and other qualification management',
'type' => 'directory',
'children' => [
'SubmitOperationAuditInfo',
'SubmitOperationCredentials',
'CancelOperationAudit',
'CancelQualificationVerification',
'ResetQualificationVerification',
'SaveRegistrantProfileRealNameVerification',
'QueryFailingReasonListForQualification',
'QueryOperationAuditInfoDetail',
'QueryOperationAuditInfoList',
'QueryQualificationDetail',
'GetOperationOssUploadPolicy',
],
],
[
'id' => 60956,
'title' => 'Other Interfaces',
'type' => 'directory',
'children' => [
[
'id' => 60918,
'title' => 'Privacy protection',
'type' => 'directory',
'children' => [
'SaveBatchTaskForDomainNameProxyService',
'SaveSingleTaskForDomainNameProxyService',
],
],
'SaveTaskForSubmittingDomainDelete',
'SaveSingleTaskForAssociatingEns',
'SaveSingleTaskForDisassociatingEns',
'SaveBatchDomainRemark',
'SaveSingleTaskForSaveArtExtension',
'QueryChangeLogList',
'QueryLocalEnsAssociation',
'QueryEnsAssociation',
'GetQualificationUploadPolicy',
'ChangeResourceGroup',
'SaveBatchTaskForReserveDropListDomain',
],
],
[
'id' => 172550,
'title' => 'Other',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
],
[
'name' => 'EnableDomainProxy',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'true',
],
],
[
'name' => 'PermitPremiumActivation',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'AliyunDns',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'true',
],
],
[
'name' => 'Dns1',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ns1.aliyun.com',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'ZhRegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'Country',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
],
[
'name' => 'Dns2',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ns2.aliyun.com',
],
],
[
'name' => 'ZhProvince',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'ZhAddress',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'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' => 'Address',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'chao yang qu',
],
],
[
'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' => '1234567',
],
],
[
'name' => 'TelArea',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '86',
],
],
[
'name' => 'Telephone',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12345678',
],
],
[
'name' => 'TelExt',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1234',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'TrademarkDomainActivation',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '123123',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '',
'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' => 'SaveSingleTaskForCreatingOrderActivate',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForCreatingOrderActivate' => [
'summary' => 'Submits a task to register multiple domain names at a time.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '1234',
],
'AliyunDns' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'PermitPremiumActivation' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'ZhProvince' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'Telephone' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1820000****',
],
'RegistrantOrganization' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zhang san',
],
'City' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'bei jing shi',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
'ZhCity' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'Dns1' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ns2.aliyun.com',
],
'TelArea' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '86',
],
'Address' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'chao yan qu *** dasha *** hao',
],
'EnableDomainProxy' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
'PostalCode' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '102629',
],
'RegistrantProfileId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '000000',
],
'ZhRegistrantOrganization' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'TrademarkDomainActivation' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
'Dns2' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'ns1.aliyun.com',
],
'ZhRegistrantName' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'Email' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'username@example.com',
],
'RegistrantType' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
'Country' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
'RegistrantName' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zhang san',
],
'SubscriptionDuration' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'ZhAddress' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
'Province' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'bei jing',
],
'ResourceGroupId' => [
'description' => '',
'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' => 'SaveBatchTaskForCreatingOrderActivate',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123123123',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'OrderRenewParam',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SubscriptionDuration' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Aliyun.com',
],
'CurrentExpirationDate' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
'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',
],
],
],
],
],
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForCreatingOrderRenew' => [
'summary' => '保存单个任务-续费订单',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'CurrentExpirationDate',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '123132',
],
],
[
'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',
],
],
],
],
],
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForCreatingOrderRedeem' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '127.0.0.1',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'en',
'required' => false,
'type' => 'string',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'example.com',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'CurrentExpirationDate',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '0000',
'format' => 'int64',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'CouponNo',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '123123',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'UseCoupon',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'false',
'required' => false,
'type' => 'boolean',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '123123',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'false',
'required' => false,
'type' => 'boolean',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => '40F46D3D-F4F3-4CCB-AC30-2DD20E32E528',
'type' => 'string',
],
'TaskNo' => [
'description' => '',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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"}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'SaveBatchTaskForCreatingOrderRedeem' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PromotionNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123213123',
],
],
[
'name' => 'UsePromotion',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'OrderRedeemParam',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DomainName' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Aliyun.com',
],
'CurrentExpirationDate' => [
'description' => '',
'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' => 'SaveBatchTaskForCreatingOrderRedeem',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'create',
],
],
[
'name' => 'FeeCurrency',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'USD',
],
],
[
'name' => 'FeePeriod',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '1',
],
'Price' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1286',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'test**.xin',
],
'Premium' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
'DynamicCheck' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'Reason' => [
'description' => '',
'type' => 'string',
'example' => 'In use',
],
'StaticPriceInfo' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PriceInfo' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'action' => [
'type' => 'string',
],
'money' => [
'type' => 'number',
'format' => 'double',
],
'period' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
],
],
'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' => 'CheckDomain',
'summary' => 'Checks whether a domain name can be registered.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'FuzzyMatchDomainSensitiveWord' => [
'summary' => '通过关键字进行模糊匹配',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Keyword',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'xxx**.cn',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'en',
'required' => false,
'type' => 'string',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '127.0.0.1',
'required' => false,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'Exist' => [
'description' => '',
'example' => 'true',
'type' => 'boolean',
],
'RequestId' => [
'description' => '',
'example' => 'D15F91FD-0B34-4E48-8CBF-EFA5D2A31586',
'type' => 'string',
],
'Keyword' => [
'description' => '',
'example' => 'xxx**.cn',
'type' => 'string',
],
'MatchedSentiveWords' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MatchedSensitiveWord' => [
'description' => '',
'type' => 'array',
'items' => [
'properties' => [
'Word' => [
'description' => '',
'example' => 'xxx',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
],
],
'type' => 'object',
],
],
],
'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"}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'FuzzyMatchDomainSensitiveWord',
],
'BatchFuzzyMatchDomainSensitiveWord' => [
'summary' => '通过关键字进行批量模糊匹配',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'example' => 'true',
],
'MatchedSentiveWords' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'MatchedSensitiveWord' => [
'description' => '',
'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"}]',
'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' => '',
'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"}]',
],
'SaveRegistrantProfile' => [
'summary' => '保存联系人模板',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'DefaultRegistrantProfile',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'Country',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '3600000',
],
],
[
'name' => 'City',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'ZhAddress',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RegistrantProfileType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'common',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RegistrantProfileId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '3600000',
],
'RequestId' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteRegistrantProfile' => [
'summary' => '删除联系人模板',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '3600000',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => 'DeleteRegistrantProfile',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'RegistrantProfileIds',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RegistrantProfileRealNameVerification' => [
'summary' => '保存联系人模板实名资料',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileID',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
],
[
'name' => 'IdentityCredential',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'dGVzdA==',
],
],
[
'name' => 'IdentityCredentialNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '43012512345678****',
],
],
[
'name' => 'IdentityCredentialType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'SFZ',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDefaultRegistrantProfile' => [
'summary' => '设置默认模板',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1234567',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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":""}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainAdminDivision' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileID',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => '',
'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' => 'QueryFailReasonForRegistrantProfileRealNameVerification',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'VerifyContactField' => [
'summary' => '校验联系人信息',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
],
],
[
'name' => 'TelArea',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryRegistrantProfiles' => [
'summary' => 'Queries the registrant profiles that belong to your Alibaba Cloud account.',
'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' => 'The language of the error message to return if the request fails. Valid values:'."\n"
."\n"
.'* **zh**: Chinese'."\n"
.'* **en**: English'."\n"
."\n"
.'Default value: **en**.'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => 'The name of the domain name registrant.'."\n",
'type' => 'string',
'required' => false,
'example' => 'li si',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client. Set the value to 127.0.0.1.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the registrant profile that you want to query. The system generates an ID after you create a registrant profile.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1234567',
],
],
[
'name' => 'DefaultRegistrantProfile',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to query the default profile. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n"
."\n"
.'Default value: **false**.'."\n",
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => 'The number of the page to return. Default value: **0**.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of entries per page. Default value: **0**. Maximum value: **5000**.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '500',
'default' => '500',
],
],
[
'name' => 'ZhRegistrantOrganization',
'in' => 'query',
'schema' => [
'description' => 'The Chinese name of the domain name registrant.'."\n",
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => 'The type of the domain name registrant. Valid values:'."\n"
."\n"
.'* **1**: individual.'."\n"
.'* **2**: enterprise.'."\n"
."\n"
.'Default value: **1**.'."\n",
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RealNameStatus',
'in' => 'query',
'schema' => [
'description' => 'The state of real-name verification for the domain name registrant. Valid values:'."\n"
."\n"
.'* **FAILED**: Real-name verification for the domain name fails.'."\n"
.'* **SUCCEED**: Real-name verification for the domain name is successful.'."\n"
.'* **NONAUDIT**: Real-name verification for the domain name is not performed.'."\n"
.'* **AUDITING**: Real-name verification for the domain name is in progress.'."\n",
'type' => 'string',
'required' => false,
'example' => 'SUCCEED',
'enum' => [
'FAILED',
'SUCCEED',
'NONAUDIT',
'AUDITING',
],
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => 'The email address of the domain name registrant.'."\n",
'type' => 'string',
'required' => false,
'example' => 'username@example.com',
],
],
[
'name' => 'RegistrantProfileType',
'in' => 'query',
'schema' => [
'description' => 'The type of the registrant profile. Valid values:'."\n"
."\n"
.'* **common**: common profile.'."\n"
.'* **cnnic**: China Internet Network Information Center (CNNIC) profile.'."\n"
."\n"
.'> Only the Alibaba Cloud international site (alibabacloud.com) supports CNNIC profiles. To register domain names provided by CNNIC such as the .cn and . domain names on the Alibaba Cloud international site, you must use a CNNIC profile. To register other domain names, use a common profile.'."\n",
'type' => 'string',
'required' => false,
'example' => 'common',
],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => [
'description' => 'The remarks.'."\n",
'type' => 'string',
'required' => false,
'example' => 'Test domain name'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextPage' => [
'description' => 'Indicates whether the current page is followed by a page. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'example' => 'true',
],
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '94053D79-7455-4F71-BF06-20EB2DEDE6BD',
],
'TotalItemNum' => [
'description' => 'The total number of entries.'."\n"
."\n"
.'> This parameter indicates the total number of queried registrant profiles. If multiple registrant profiles are queried, the information about these profiles is returned in sequence by profile.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '9',
],
'PrePage' => [
'description' => 'Indicates whether the current page is preceded by a page. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => 'The page number returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalPageNum' => [
'description' => 'The total number of returned pages.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => 'The number of entries returned on each page. Default value: **0**. Maximum value: **5000**.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'RegistrantProfiles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'RegistrantProfile' => [
'description' => 'The list of registrant profiles.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TelExt' => [
'description' => 'The extension of the phone number.'."\n",
'type' => 'string',
'example' => '1234',
],
'UpdateTime' => [
'description' => 'The time when the registrant profile was updated.'."\n",
'type' => 'string',
'example' => '2019-03-15 15:32:45',
],
'ZhProvince' => [
'description' => 'The province where the domain name registrant is located, in Chinese.'."\n",
'type' => 'string',
'example' => '',
],
'CreateTime' => [
'description' => 'The time when the registrant profile was created.'."\n",
'type' => 'string',
'example' => '2019-02-18 10:46:47',
],
'Telephone' => [
'description' => 'The phone number.'."\n",
'type' => 'string',
'example' => '1829756****',
],
'RegistrantOrganization' => [
'description' => 'The name of the domain name registrant.'."\n",
'type' => 'string',
'example' => 'li si',
],
'City' => [
'description' => 'The city where the domain name registrant is located, in English.'."\n",
'type' => 'string',
'example' => 'hang zhou shi',
],
'ZhCity' => [
'description' => 'The city where the domain name registrant is located, in Chinese.'."\n",
'type' => 'string',
'example' => '',
],
'TelArea' => [
'description' => 'The international dialing code of the country or region where the domain name contact is located. For example, the international dialing code of China is **86**.'."\n",
'type' => 'string',
'example' => '86',
],
'Address' => [
'description' => 'The address of the domain name registrant.'."\n",
'type' => 'string',
'example' => 'zhe jiang sheng hang zhou shi shi li qu shi li zhen shi li da sha 1001 hao',
],
'RealNameStatus' => [
'description' => 'The state of real-name verification for the domain name registrant. Valid values:'."\n"
."\n"
.'* **FAILED**: Real-name verification for the domain name fails.'."\n"
.'* **SUCCEED**: Real-name verification for the domain name is successful.'."\n"
.'* **NONAUDIT**: Real-name verification for the domain name is not performed.'."\n"
.'* **AUDITING**: Real-name verification for the domain name is in progress.'."\n",
'type' => 'string',
'example' => 'SUCCEED',
],
'PostalCode' => [
'description' => 'The postal code of the region where the domain name registrant is located.'."\n",
'type' => 'string',
'example' => '310024',
],
'RegistrantProfileType' => [
'description' => 'The type of the registrant profile. Valid values:'."\n"
."\n"
.'* **common**: common profile.'."\n"
.'* **cnnic**: CNNIC profile.'."\n"
."\n"
.'> Only the Alibaba Cloud international site (alibabacloud.com) supports CNNIC profiles. To register domain names provided by CNNIC such as the .cn and . domain names on the Alibaba Cloud international site, you must use a CNNIC profile. To register other domain names, use a common profile.'."\n",
'type' => 'string',
'example' => 'common',
],
'RegistrantProfileId' => [
'description' => 'The ID of the registrant profile.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1000001',
],
'ZhRegistrantOrganization' => [
'description' => 'The Chinese name of the domain name registrant.'."\n",
'type' => 'string',
'example' => '',
],
'DefaultRegistrantProfile' => [
'description' => 'Indicates whether the template is the default template. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n"
."\n"
.'Default value: **false**.'."\n",
'type' => 'boolean',
'example' => 'false',
],
'Email' => [
'description' => 'The email address of the domain name registrant.'."\n",
'type' => 'string',
'example' => '82106****@qq.com',
],
'ZhRegistrantName' => [
'description' => 'The Chinese name of the domain name contact.'."\n",
'type' => 'string',
'example' => '',
],
'RegistrantType' => [
'description' => 'The type of the domain name registrant. Valid values:'."\n"
."\n"
.'* **1**: individual.'."\n"
.'* **2**: enterprise.'."\n"
."\n"
.'Default value: **1**.'."\n",
'type' => 'string',
'example' => '1',
],
'Country' => [
'description' => 'The code of the country or region where the domain name registrant is located, such as **CN** or **US**.'."\n",
'type' => 'string',
'example' => 'CN',
],
'RegistrantName' => [
'description' => 'The name of the domain name contact.'."\n",
'type' => 'string',
'example' => 'li si',
],
'EmailVerificationStatus' => [
'description' => 'The status of the verification for the email address. Valid values:'."\n"
."\n"
.'* **0**: not verified'."\n"
.'* **1**: verified'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ZhAddress' => [
'description' => 'The address of the domain name registrant, in Chinese.'."\n",
'type' => 'string',
'example' => '',
],
'Province' => [
'description' => 'The province where the domain name registrant is located.'."\n",
'type' => 'string',
'example' => 'zhe jiang',
],
'CredentialNo' => [
'description' => 'The certificate number.'."\n",
'type' => 'string',
'example' => '4****************1',
],
'CredentialType' => [
'description' => 'The certificate type.'."\n",
'type' => 'string',
'example' => 'YYZZ',
],
'Remark' => [
'description' => 'The remarks.'."\n",
'type' => 'string',
'example' => 'Test domain name'."\n",
],
'Params' => [
'type' => 'string',
],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'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' => 'QueryRegistrantProfiles',
'description' => 'You can use optional request parameters to specify specific query criteria to query registrant profiles as required. For example:'."\n"
."\n"
.'* If you know the ID of the profile that you want to query, you can use the registrant profile ID parameter to query the detailed information about the profile.'."\n"
.'* If you do not know the ID of the profile that you want to query, you can use parameters such as the registrant name parameter to query the detailed information about the profile.'."\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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234567',
],
],
[
'name' => 'FetchImage',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'IdentityCredentialType' => [
'description' => '',
'type' => 'string',
'example' => 'SFZ',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '4D73432C-7600-4779-ACBB-C3B5CA145D32',
],
'ModificationDate' => [
'description' => '',
'type' => 'string',
'example' => '2017-05-22 19:04:49',
],
'IdentityCredential' => [
'description' => '',
'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' => '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' => null,
],
'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' => null,
],
'CancelDomainVerification' => [
'summary' => 'Cancels real-name verification for a domain name.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client. Set the value to **127.0.0.1**.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1 ',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => 'The language of the error message to return if the request fails. Valid values:'."\n"
."\n"
.'* **zh**: Chinese.'."\n"
.'* **en**: English.'."\n"
."\n"
.'Default value: **en**.'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => 'Thee instance ID of the domain name. You can call the [QueryDomainList](~~67712~~) operation to query the instance ID.'."\n",
'type' => 'string',
'required' => true,
'example' => 'S2019270W570xxxx',
],
],
[
'name' => 'ActionType',
'in' => 'query',
'schema' => [
'description' => 'The action type. Valid values:'."\n"
."\n"
.'* **DOMAINAUDIT**: review a domain name review.'."\n"
.'* **AUDITCONTACT**: review a contact.'."\n",
'type' => 'string',
'required' => true,
'example' => 'AUDITCONTACT',
'enum' => [
'DOMAINAUDIT',
'AUDITCONTACT',
],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '0AC0AF67-D303-4EB9-B20E-B4D4B2C3F97B',
],
],
'description' => '',
],
],
],
'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' => 'CancelDomainVerification',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainRealNameVerificationInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'IdentityCredentialType' => [
'description' => '',
'type' => 'string',
'example' => 'SFZ',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '4DF9D693-0D5B-4EB7-8922-7ECA6BD59314',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'S2019270W570****',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'aliyundoc.com',
],
'IdentityCredential' => [
'description' => '',
'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' => '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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'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' => 'QueryFailReasonForDomainRealNameVerification',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteEmailVerification' => [
'summary' => '删除邮箱验证',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => '',
'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' => '',
'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' => 'DeleteEmailVerification',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'VerifyEmail' => [
'summary' => '验证邮箱Token',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Token',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '0b32247496409441e9e179ea7c2e0****',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => 'VerifyEmail',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ResendEmailVerification' => [
'summary' => '重新发送验证邮件',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => '',
'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' => '',
'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' => 'ResendEmailVerification',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SubmitEmailVerification' => [
'summary' => '提交邮箱验证',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => '',
'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' => '',
'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' => '',
'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 MissingEmail\\n Email is mandatory for this action.\\n \\n \\n \\n"}]',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'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' => '',
'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' => '',
'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' => '',
'type' => 'boolean',
'example' => 'true',
],
'ModificationDateLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'ResultCode' => [
'description' => '',
'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' => '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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '11',
],
'UserId' => [
'description' => '',
'type' => 'string',
'example' => '123456',
],
'ModificationDate' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => 'clientCancelled',
],
'NeedMailCheck' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'ModificationDateLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'S20181T0WLI85212',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'example.com',
],
'ProgressBarType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ResultMsg' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'ResultDateLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'ExpirationDate' => [
'description' => '',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'Email' => [
'description' => '',
'type' => 'string',
'example' => 'username@example.com',
],
'WhoisMailStatus' => [
'description' => '',
'type' => 'boolean',
'example' => 'true',
],
'TransferAuthorizationCodeSubmissionDate' => [
'description' => '',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'SubmissionDate' => [
'description' => '',
'type' => 'string',
'example' => '2018-03-28 00:41:42',
],
'ExpirationDateLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1514428524669',
],
'SimpleTransferInStatus' => [
'description' => '',
'type' => 'string',
'example' => 'FAIL',
],
'ResultDate' => [
'description' => '',
'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' => 'QueryTransferInList',
'summary' => 'Queries the domain names that are transferred to Alibaba Cloud.',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => [
'description' => '',
'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' => 'QueryTransferOutInfo',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'CheckTransferInFeasibility' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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"}]',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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"}]',
],
'CancelTask' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'TaskNo',
'in' => 'query',
'schema' => [
'description' => '',
'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' => 'CancelTask',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AcknowledgeTaskResult' => [
'summary' => '确认任务结果',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryTaskDetailHistory' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'TaskNo',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'string',
'example' => 'S1234456789',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'TaskStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TaskStatus' => [
'description' => '',
'type' => 'string',
'example' => 'EXECUTE_SUCCESS',
],
'TaskTypeDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'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' => '',
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'S123456789',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'TaskStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '',
'type' => 'string',
'example' => 'EXECUTE_FAILURE',
],
'TaskTypeDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'TryCount' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'ErrorMsg' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'S123456789',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'TaskStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '',
'type' => 'string',
'example' => 'EXECUTE_FAILURE',
],
'TaskTypeDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'TryCount' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '2019-07-30 00:00:00',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'S1234567890',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => '',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '',
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'TaskStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '',
'type' => 'string',
'example' => 'EXECUTE_FAILURE',
],
'TaskTypeDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'TryCount' => [
'description' => '',
'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' => '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' => '',
'example' => '127.0.0.1',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'en',
'required' => false,
'type' => 'string',
'default' => 'en',
],
],
[
'name' => 'TaskNo',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '75addb07-28a3-450e-b5ec-test',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'example.com',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'S20181T0WLI85212',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'TaskResultStatus',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '2',
'format' => 'int32',
'required' => false,
'type' => 'integer',
'enum' => [
'2',
'3',
],
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '20',
'format' => 'int32',
'required' => true,
'type' => 'integer',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'PrePage' => [
'description' => '',
'example' => 'false',
'type' => 'boolean',
],
'CurrentPageNum' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'RequestId' => [
'description' => '',
'example' => 'E879DC07-38EE-4408-9F33-73B30CD965CD',
'type' => 'string',
],
'PageSize' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'TotalPageNum' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'type' => 'integer',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TaskDetail' => [
'description' => '',
'type' => 'array',
'items' => [
'properties' => [
'UpdateTime' => [
'description' => '',
'example' => '2018-03-26 15:22:18',
'type' => 'string',
],
'TaskDetailNo' => [
'description' => '',
'example' => '15fee9d10d514bada66bd08c5723c583',
'type' => 'string',
],
'CreateTime' => [
'description' => '',
'example' => '2018-03-26 15:08:20',
'type' => 'string',
],
'InstanceId' => [
'description' => '',
'example' => 'S201817141000000',
'type' => 'string',
],
'DomainName' => [
'description' => '',
'example' => 'example.com',
'type' => 'string',
],
'TaskType' => [
'description' => '',
'example' => 'CHG_DNS',
'type' => 'string',
],
'TaskNo' => [
'description' => '',
'example' => 'b95bc334-f7d8-4f39-8a62-4c4302a243d8',
'type' => 'string',
],
'TaskResult' => [
'description' => '',
'example' => 'test',
'type' => 'string',
],
'TaskStatusCode' => [
'description' => '',
'example' => '2',
'format' => 'int32',
'type' => 'integer',
],
'TaskStatus' => [
'description' => '',
'example' => 'EXECUTE_SUCCESS',
'type' => 'string',
],
'TaskTypeDescription' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'TryCount' => [
'description' => '',
'example' => '0',
'format' => 'int32',
'type' => 'integer',
],
'ErrorMsg' => [
'description' => '',
'example' => 'The operation is successful.',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
],
'TotalItemNum' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'type' => 'integer',
],
'NextPage' => [
'description' => '',
'example' => 'false',
'type' => 'boolean',
],
],
'type' => 'object',
],
],
],
'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"}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'QueryTaskList' => [
'summary' => 'Queries the domain name tasks under your account by page.',
'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' => '',
'example' => '127.0.0.1',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'en',
'required' => false,
'type' => 'string',
'default' => 'en',
],
],
[
'name' => 'BeginCreateTime',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '1522080000000',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
],
[
'name' => 'EndCreateTime',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '1522080000000',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '1',
'format' => 'int32',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '2',
'format' => 'int32',
'required' => true,
'type' => 'integer',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'PrePage' => [
'description' => '',
'example' => 'false',
'type' => 'boolean',
],
'CurrentPageNum' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'RequestId' => [
'description' => '',
'example' => '8D7D294A-8E99-481F-B64C-017EFC793059',
'type' => 'string',
],
'PageSize' => [
'description' => '',
'example' => '2',
'format' => 'int32',
'type' => 'integer',
],
'TotalPageNum' => [
'description' => '',
'example' => '22',
'format' => 'int32',
'type' => 'integer',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TaskInfo' => [
'description' => '',
'type' => 'array',
'items' => [
'properties' => [
'TaskType' => [
'description' => '',
'example' => 'CREATE_DNSHOST',
'type' => 'string',
],
'TaskCancelStatus' => [
'description' => '',
'example' => 'INIT',
'type' => 'string',
],
'TaskNo' => [
'description' => '',
'example' => '8b1cd755-4928-4b02-adee-e5d41d7b1939',
'type' => 'string',
],
'TaskCancelStatusCode' => [
'description' => '',
'example' => '0',
'format' => 'int32',
'type' => 'integer',
],
'TaskStatusCode' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'TaskStatus' => [
'description' => '',
'example' => 'COMPLETE',
'type' => 'string',
],
'TaskTypeDescription' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'TaskNum' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'CreateTime' => [
'description' => '',
'example' => 'Dec 26,2017 11:00:54',
'type' => 'string',
],
'Clientip' => [
'description' => '',
'example' => '127.0.0.1',
'type' => 'string',
],
'TaskBizType' => [
'type' => 'string',
],
'TaskResult' => [
'type' => 'string',
],
'TaskTypeCode' => [
'type' => 'integer',
'format' => 'int32',
],
],
'type' => 'object',
],
],
],
],
'TotalItemNum' => [
'description' => '',
'example' => '43',
'format' => 'int32',
'type' => 'integer',
],
'NextPage' => [
'description' => '',
'example' => 'true',
'type' => 'boolean',
],
],
'type' => 'object',
],
],
],
'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"}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'QueryTaskList',
],
'QueryTaskInfoHistory' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'BeginCreateTime',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndCreateTime',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '',
'type' => 'string',
'example' => 'aa634d3f-927e-4d17-9d2c-test',
],
'TaskStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '',
'type' => 'string',
'example' => 'COMPLETE',
],
'TaskTypeDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'TaskNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2017-11-01 17:22:51',
],
'CreateTimeLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1509528171000',
],
'Clientip' => [
'description' => '',
'type' => 'string',
'example' => '127.0.0.1',
],
],
],
'Objects' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskType' => [
'description' => '',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '',
'type' => 'string',
'example' => 'aa634d3f-927e-4d17-9d2c-test',
],
'TaskStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '',
'type' => 'string',
'example' => 'COMPLETE',
],
'TaskTypeDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'TaskNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2017-11-01 17:22:51',
],
'CreateTimeLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1509528171000',
],
'Clientip' => [
'description' => '',
'type' => 'string',
'example' => '127.0.0.1',
],
],
],
],
'PrePageCursor' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskType' => [
'description' => '',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '',
'type' => 'string',
'example' => 'f9baa3d5-33b9-4c81-8847-test',
],
'TaskStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '',
'type' => 'string',
'example' => 'COMPLETE',
],
'TaskTypeDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'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' => '',
'type' => 'string',
'example' => '127.0.0.1',
],
],
],
'NextPageCursor' => [
'description' => '',
'type' => 'object',
'properties' => [
'TaskType' => [
'description' => '',
'type' => 'string',
'example' => 'CHG_DNS',
],
'TaskNo' => [
'description' => '',
'type' => 'string',
'example' => '8f112aa1-98be-48c3-82f8-test',
],
'TaskStatusCode' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'TaskStatus' => [
'description' => '',
'type' => 'string',
'example' => 'COMPLETE',
],
'TaskTypeDescription' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'TaskNum' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '15',
],
'CreateTime' => [
'description' => '',
'type' => 'string',
'example' => '2017-10-27 13:07:07',
],
'CreateTimeLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1509080827000',
],
'Clientip' => [
'description' => '',
'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' => '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' => 'The task status. Valid value:'."\n"
."\n"
.'* **0**: waiting for execution'."\n"
.'* **1**: being executed'."\n"
.'* **2**: successful'."\n"
.'* **3**: failed'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '2',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => 'The language of the error message to return if the request fails. Valid value:'."\n"
."\n"
.'* **zh**: Chinese'."\n"
.'* **en**: English'."\n"
."\n"
.'Default value: **en**.'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'TaskNo',
'in' => 'query',
'schema' => [
'description' => 'The task ID.'."\n",
'type' => 'string',
'required' => true,
'example' => '75addb07-28a3-450e-b5ec-test',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => 'The domain name.'."\n",
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => 'The instance ID of the domain name.'."\n",
'type' => 'string',
'required' => false,
'example' => 'S20179H1BBI9test',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client. Set the value to **127.0.0.1**.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.0',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => 'The page number.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of entries to return on each page. Maximum value: **1000**.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => 'Indicates whether the current page is preceded by a page.'."\n",
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => 'The page number returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '6A2320E4-D870-49C9-A6DC-test',
],
'PageSize' => [
'description' => 'The number of entries per page.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TotalPageNum' => [
'description' => 'The total number of pages.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TaskDetail' => [
'description' => 'The tasks.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'UpdateTime' => [
'description' => 'The last time when the task was run.'."\n",
'type' => 'string',
'example' => '2018-01-25 20:47:01',
],
'TaskDetailNo' => [
'description' => 'The ID of the task details.'."\n",
'type' => 'string',
'example' => '75addb07-28a3-450e-b5ec-test',
],
'CreateTime' => [
'description' => 'The time when the task was created.'."\n",
'type' => 'string',
'example' => '2018-01-25 20:46:57',
],
'InstanceId' => [
'description' => 'The instance ID of the domain name.'."\n",
'type' => 'string',
'example' => 'S20179H1BBI9test',
],
'DomainName' => [
'description' => 'The domain name.'."\n",
'type' => 'string',
'example' => 'example.com',
],
'TaskType' => [
'description' => 'The task type. Valid values:'."\n"
."\n"
.'* **CHG_HOLDER**: The task is run to modify the domain name registrant.'."\n"
.'* **CHG_DNS**: The task is run to change the Domain Name System (DNS) servers.'."\n"
.'* **SET_WHOIS_PROTECT**: The task is run to configure privacy protection for the domain name.'."\n"
.'* **UPDATE_ADMIN_CONTACT**: The task is run to modify the information about the administrator of the domain name.'."\n"
.'* **UPDATE_BILLING_CONTACT**: The task is run to modify the information about the payer for the domain name.'."\n"
.'* **UPDATE_TECH_CONTACT**: The task is run to modify the information about the technical support for the domain name.'."\n"
.'* **SET_UPDATE_PROHIBITED**: The task is run to configure the security lock for the domain name.'."\n"
.'* **SET_TRANSFER_PROHIBITED**: The task is run to configure the transfer lock for the domain name.'."\n"
.'* **ORDER_ACTIVATE**: The task is run to create a registration order for the domain name.'."\n"
.'* **ORDER_RENEW**: The task is run to create a renewal order for the domain name.'."\n"
.'* **ORDER_REDEEM**: The task is run to create a redemption order for the domain name.'."\n"
.'* **CREATE_DNSHOST**: The task is run to create a DNS server for the domain name.'."\n"
.'* **UPDATE_DNSHOST**: The task is run to update the information about a DNS server for the domain name.'."\n"
.'* **SYNC_DNSHOST**: The task is run to synchronize a DNS server for the domain name.'."\n",
'type' => 'string',
'example' => 'ORDER_RENEW',
],
'TaskNo' => [
'description' => 'The task ID.'."\n",
'type' => 'string',
'example' => '60d6e201-8ee5-47ab-8fdc-test',
],
'TaskResult' => [
'description' => 'The result of the task.'."\n",
'type' => 'string',
'example' => '12345',
],
'TaskStatusCode' => [
'description' => 'The status code of the task. Valid values:'."\n"
."\n"
.'* **0**: waiting for execution'."\n"
.'* **1**: being executed'."\n"
.'* **2**: successful'."\n"
.'* **3**: failed'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'TaskStatus' => [
'description' => 'The task status. Valid values:'."\n"
."\n"
.'* **WAITING_EXECUTE**: To be executed'."\n"
.'* **EXECUTING**: being executed'."\n"
.'* **EXECUTE_SUCCESS**: successful'."\n"
.'* **EXECUTE_FAILURE**: failed'."\n",
'type' => 'string',
'example' => 'EXECUTE_SUCCESS',
],
'TaskTypeDescription' => [
'description' => 'The description of the task type.'."\n",
'type' => 'string',
'example' => '',
],
'TryCount' => [
'description' => 'The number of times the task was retried.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'ErrorMsg' => [
'description' => 'The error message returned when the task failed.'."\n",
'type' => 'string',
'example' => 'The operation is successful.',
],
'FailReason' => [
'description' => 'The cause of a domain name task failure.'."\n",
'type' => 'string',
'example' => 'Purchase record exists for the domain name in Aliyun'."\n",
],
],
'description' => '',
],
],
],
],
'TotalItemNum' => [
'description' => 'The total number of entries.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NextPage' => [
'description' => 'Indicates whether the current page is followed by a page.'."\n",
'type' => 'boolean',
'example' => 'true',
],
],
'description' => '',
],
],
],
'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' => 'QueryTaskDetailList',
'summary' => 'Queries the details of a specific domain name task by page.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainByDomainName' => [
'summary' => 'Queries the information about a domain name.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => 'The language of the error message to return if the request fails. Valid values:'."\n"
."\n"
.'* **zh**: Chinese.'."\n"
.'* **en**: English.'."\n"
."\n"
.'Default value: **en**.'."\n",
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => 'The domain name.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Email' => [
'description' => 'The email address of the domain name registrant.'."\n",
'type' => 'string',
'example' => 'username@example.com',
],
'RegistrationDate' => [
'description' => 'The time when the domain name was registered.'."\n",
'type' => 'string',
'example' => '2017-12-07 17:02:13',
],
'RegistrationDateLong' => [
'description' => 'The timestamp generated when the domain name was registered.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1584675448000',
],
'RealNameStatus' => [
'description' => 'The status of real-name verification for the domain name. Valid values:'."\n"
."\n"
.'* **NONAUDIT**: The real-name verification is not performed.'."\n"
.'* **SUCCEED**: The real-name verification is successful.'."\n"
.'* **FAILED**: The real-name verification fails.'."\n"
.'* **AUDITING**: The real-name verification is in progress.'."\n",
'type' => 'string',
'example' => 'NONAUDIT',
],
'Premium' => [
'description' => 'Indicates whether the domain name is a premium domain name.'."\n",
'type' => 'boolean',
'example' => 'false',
],
'DomainNameVerificationStatus' => [
'description' => 'The status of name auditing for the domain name. Valid values:'."\n"
."\n"
.'* **NONAUDIT**: The name auditing for the domain name is not performed.'."\n"
.'* **SUCCEED**: The name auditing for the domain name is successful.'."\n"
.'* **FAILED**: The name auditing for the domain name fails.'."\n"
.'* **AUDITING**: The name auditing for the domain name is in progress.'."\n",
'type' => 'string',
'example' => 'SUCCEED',
],
'ExpirationDateLong' => [
'description' => 'The timestamp generated when the domain name expired.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1625111915000',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Dns' => [
'description' => 'The Domain Name System (DNS) servers of the domain name.'."\n",
'type' => 'array',
'items' => [
'description' => 'The DNS servers of the domain name.'."\n",
'type' => 'string',
'example' => 'dns1.hichina.com,dns2.hichina.com',
],
],
],
],
'TransferOutStatus' => [
'description' => 'The transfer status of the domain name. Valid values:'."\n"
."\n"
.'* **NORMAL**: The domain name is normal.'."\n"
.'* **PENDING**: The domain name is being transferred out from Alibaba Cloud.'."\n",
'type' => 'string',
'example' => 'NORMAL',
],
'ZhRegistrantOrganization' => [
'description' => 'The Chinese name of the domain name registrant.'."\n",
'type' => 'string',
'example' => '',
],
'EmailVerificationClientHold' => [
'description' => 'Indicates whether the domain name is in the ClientHold state.'."\n",
'type' => 'boolean',
'example' => 'false',
],
'EmailVerificationStatus' => [
'description' => 'Indicates whether the email address passes verification. Valid values:'."\n"
."\n"
.'* **0**: The email address fails the verification.'."\n"
.'* **1**: The email address passes the verification.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RegistrantOrganization' => [
'description' => 'The registrant of the domain name.'."\n",
'type' => 'string',
'example' => 'Test litm',
],
'TransferProhibitionLock' => [
'description' => 'The status of the transfer lock for the domain name. Valid values:'."\n"
."\n"
.'* **NONE_SETTING**: No transfer lock is configured.'."\n"
.'* **OPEN**: The transfer lock is enabled.'."\n"
.'* **CLOSE**: The transfer lock is disabled.'."\n",
'type' => 'string',
'example' => 'CLOSE',
],
'DomainNameProxyService' => [
'description' => 'Indicates whether privacy protection is enabled for the domain name.'."\n",
'type' => 'boolean',
'example' => 'false',
],
'RegistrantType' => [
'description' => 'The type of contact who registers the domain name. Valid values:'."\n"
."\n"
.'* **1**: individual.'."\n"
.'* **2**: enterprise.'."\n",
'type' => 'string',
'example' => '1',
],
'RegistrantUpdatingStatus' => [
'description' => 'The status of the information about the domain name registrant. Valid values:'."\n"
."\n"
.'* **PENDING**: The information about the domain name registrant is being modified.'."\n"
.'* **NORMAL**: normal.'."\n",
'type' => 'string',
'example' => 'NORMAL',
],
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '44101664-3E70-4F0E-89E5-CCB74BF*****',
],
'DomainName' => [
'description' => 'The domain name.'."\n",
'type' => 'string',
'example' => 'example.com',
],
'InstanceId' => [
'description' => 'The instance ID of the domain name.'."\n",
'type' => 'string',
'example' => 'S20179H1BBI9****',
],
'ZhRegistrantName' => [
'description' => 'The Chinese name of the domain name contact.'."\n",
'type' => 'string',
'example' => '',
],
'ExpirationDate' => [
'description' => 'The expiration date.'."\n",
'type' => 'string',
'example' => '2019-12-07 17:02:13',
],
'RegistrantName' => [
'description' => 'The name of the contact.'."\n",
'type' => 'string',
'example' => 'Test litm',
],
'UserId' => [
'description' => 'The user ID.'."\n",
'type' => 'string',
'example' => '121000000****',
],
'UpdateProhibitionLock' => [
'description' => 'The status of the security lock for the domain name. Valid values:'."\n"
."\n"
.'* **NONE_SETTING**: No security lock is configured.'."\n"
.'* **OPEN**: The security lock is enabled.'."\n"
.'* **CLOSE**: The security lock is disabled.'."\n",
'type' => 'string',
'example' => 'CLOSE',
],
'DomainGroupId' => [
'description' => 'The ID of the domain name group. You can call the [QueryDomainGroupList](~~69362~~) operation to query the ID of the domain name group.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '123456',
],
'Remark' => [
'description' => 'The remarks on the domain name.'."\n",
'type' => 'string',
'example' => '',
],
'DomainGroupName' => [
'description' => 'The name of the domain name group.'."\n",
'type' => 'string',
'example' => '',
],
'ExpirationDateStatus' => [
'description' => 'Indicates whether the domain name expires. Valid values:'."\n"
."\n"
.'* **1**: The domain name does not expire.'."\n"
.'* **2**: The domain name expires.'."\n",
'type' => 'string',
'example' => '1',
],
'ExpirationCurrDateDiff' => [
'description' => 'The number of days from the expiration date of the domain name to the current date.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '356',
],
'DomainType' => [
'description' => 'The type of the domain name. Valid values:'."\n"
."\n"
.'* New gTLD'."\n"
.'* gTLD'."\n"
.'* ccTLD'."\n",
'type' => 'string',
'example' => 'gTLD',
],
'DomainStatus' => [
'description' => 'The status of the domain name. Valid values:'."\n"
."\n"
.'* 1: The domain name needs to be renewed.'."\n"
.'* 2: The domain name needs to be redeemed.'."\n"
.'* 3: The domain name is normal.'."\n",
'type' => 'string',
'example' => '3',
],
'ResourceGroupId' => [
'description' => 'The ID of the resource group.'."\n",
'type' => 'string',
'example' => 'rg-acfmw6bpc6n7zai',
],
'Tag' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => 'The tags.'."\n",
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'description' => 'The tag key.'."\n",
'type' => 'string',
'example' => '',
],
'Vaue' => [
'description' => 'The tag value.'."\n",
'type' => 'string',
'example' => '',
],
],
],
],
],
],
],
'description' => '',
],
],
],
'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' => 'QueryDomainByDomainName',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryContactInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'string',
'example' => 'CN',
],
'RegistrantOrganization' => [
'description' => '',
'type' => 'string',
'example' => 'zhang san',
],
'TelExt' => [
'description' => '',
'type' => 'string',
'example' => '1234',
],
'TelArea' => [
'description' => '',
'type' => 'string',
'example' => '86',
],
'ZhAddress' => [
'description' => '',
'type' => 'string',
'example' => '',
],
],
],
],
],
'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' => 'QueryContactInfo',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainByInstanceId' => [
'summary' => '根据实例id查询域名信息',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => 'NONAUDIT',
],
'Premium' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'DomainNameVerificationStatus' => [
'description' => '',
'type' => 'string',
'example' => 'NONAUDIT',
],
'ExpirationDateLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1625111915000',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Dns' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => 'dns1.hichina.com,dns2.hichina.com',
],
],
],
],
'TransferOutStatus' => [
'description' => '',
'type' => 'string',
'example' => 'NORMAL',
],
'ZhRegistrantOrganization' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'EmailVerificationClientHold' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'EmailVerificationStatus' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RegistrantOrganization' => [
'description' => '',
'type' => 'string',
'example' => 'Test litm',
],
'TransferProhibitionLock' => [
'description' => '',
'type' => 'string',
'example' => 'CLOSE',
],
'DomainNameProxyService' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'RegistrantType' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'RegistrantUpdatingStatus' => [
'description' => '',
'type' => 'string',
'example' => 'NORMAL',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '23C9B3C4-9E2C-4405-A88D-BD33E459D140',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'example.com',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'S20179H1BBI9test',
],
'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' => '',
'type' => 'string',
'example' => 'CLOSE',
],
'DomainGroupId' => [
'title' => '域名分组ID',
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1234',
],
'Remark' => [
'title' => '备注',
'description' => '',
'type' => 'string',
'example' => '',
],
'DomainGroupName' => [
'title' => '域名分组名称',
'description' => '',
'type' => 'string',
'example' => '',
],
'ExpirationDateStatus' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'ExpirationCurrDateDiff' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '356',
],
'DomainType' => [
'description' => '',
'type' => 'string',
'example' => 'gTLD',
],
'DomainStatus' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'ResourceGroupId' => [
'description' => '',
'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' => '',
],
],
],
],
],
],
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainList' => [
'summary' => 'Queries a list of domain names within your Alibaba Cloud account by page.',
'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' => 'The end of the time range to query domain names based on expiration dates. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed from January 1, 1970, 00:00:00 UTC to the time you perform the query. Only queries by day are supported.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'StartExpirationDate',
'in' => 'query',
'schema' => [
'description' => 'The beginning of the time range to query domain names based on expiration dates. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed from January 1, 1970, 00:00:00 UTC to the time you perform the query. Only queries by day are supported.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client. Set the value to **127.0.0.1**.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => 'The language of the error message to return if the request fails. Valid values:'."\n"
."\n"
.'* **zh**: Chinese'."\n"
.'* **en**: English'."\n"
."\n"
.'Default value: **en**.'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'QueryType',
'in' => 'query',
'schema' => [
'description' => 'The category of the domain names that you want to query. Valid values:'."\n"
."\n"
.'* **1**: the domain names that need to be renewed'."\n"
.'* **2**: the domain names that need to be redeemed'."\n",
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'StartRegistrationDate',
'in' => 'query',
'schema' => [
'description' => 'The beginning of the time range to query domain names based on registration dates. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Only queries by day are supported.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndRegistrationDate',
'in' => 'query',
'schema' => [
'description' => 'The end of the time range to query domain names based on registration dates. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Only queries by day are supported.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => 'The domain name. You can search for the domain name in the domain name list.'."\n",
'type' => 'string',
'required' => false,
'example' => 'test.com',
],
],
[
'name' => 'OrderByType',
'in' => 'query',
'schema' => [
'description' => 'The order of the information based on which the domain names are sorted, such as the registration date and expiration date. Valid values:'."\n"
."\n"
.'* **ASC**: ascending order'."\n"
.'* **DESC**: descending order'."\n"
."\n"
.'> If this parameter is not specified, the default value **DESC** is used.'."\n",
'type' => 'string',
'required' => false,
'example' => 'ASC',
],
],
[
'name' => 'OrderKeyType',
'in' => 'query',
'schema' => [
'description' => 'The field that you use to sort the domain names. Valid values:'."\n"
."\n"
.'* **RegistrationDate**: registration date'."\n"
.'* **ExpirationDate**: expiration date'."\n"
."\n"
.'> If this parameter is not specified, the domain names are sorted by the time when they were added to the database.'."\n",
'type' => 'string',
'required' => false,
'example' => 'RegistrationDate',
],
],
[
'name' => 'ProductDomainType',
'in' => 'query',
'schema' => [
'description' => 'The type of the domain name. Valid values:'."\n"
."\n"
.'* **New gTLD**: new generic top-level domain names'."\n"
.'* **gTLD**: generic top-level domain names'."\n"
.'* **ccTLD**: country code top-level domain names'."\n",
'type' => 'string',
'required' => false,
'example' => 'New gTLD',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => 'The page number.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of entries per page.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '10',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the domain name group.'."\n",
'type' => 'string',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the resource group.'."\n",
'type' => 'string',
'required' => false,
'example' => 'rg-aek2indvyxgpfti',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tags to add to the resource.'."\n",
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'description' => 'The key of the tag to add to the resource.'."\n",
'type' => 'string',
'required' => false,
'example' => 'testKey',
],
'Value' => [
'description' => 'The value of the tag to add to the resource.'."\n",
'type' => 'string',
'required' => false,
'example' => 'testValue',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
[
'name' => 'Ccompany',
'in' => 'query',
'schema' => [
'description' => 'The name of the domain name registrant.'."\n",
'type' => 'string',
'required' => false,
'example' => 'Guangzhou Jinye Renewable Resources Recycling Co., Ltd'."\n",
],
],
[
'name' => 'Registrar',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Dns',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => 'Indicates whether the current page is preceded by a page.'."\n",
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => 'The page number.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => 'B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E',
],
'PageSize' => [
'description' => 'The number of entries per page.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalPageNum' => [
'description' => 'The total number of pages returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Domain' => [
'description' => 'The domain names.'."\n",
'type' => 'array',
'items' => [
'description' => 'The domain names.'."\n",
'type' => 'object',
'properties' => [
'DomainAuditStatus' => [
'description' => 'The state of real-name verification for the domain name. Valid values:'."\n"
."\n"
.'* **FAILED**: Real-name verification for the domain name fails.'."\n"
.'* **SUCCEED**: Real-name verification for the domain name is successful.'."\n"
.'* **NONAUDIT**: Real-name verification for the domain name is not performed.'."\n"
.'* **AUDITING**: Real-name verification for the domain name is in progress.'."\n",
'type' => 'string',
'example' => 'FAILED',
],
'DomainGroupId' => [
'description' => 'The ID of the domain name group.'."\n",
'type' => 'string',
'example' => '123456',
],
'Remark' => [
'description' => 'The remarks of the domain name.'."\n",
'type' => 'string',
'example' => 'test remark',
],
'DomainGroupName' => [
'description' => 'The name of the domain name group.'."\n",
'type' => 'string',
'example' => 'test group',
],
'RegistrationDate' => [
'description' => 'The time when the domain name was registered.'."\n",
'type' => 'string',
'example' => '2017-11-02 04:00:45',
],
'InstanceId' => [
'description' => 'The instance ID.'."\n",
'type' => 'string',
'example' => 'ST20151102120031118',
],
'DomainName' => [
'description' => 'The domain name.'."\n",
'type' => 'string',
'example' => 'test.com',
],
'ExpirationDateStatus' => [
'description' => 'Indicates whether the domain name expires. Valid values:'."\n"
."\n"
.'* **1**: The domain name does not expire.'."\n"
.'* **2**: The domain name expires.'."\n",
'type' => 'string',
'example' => '1',
],
'ExpirationDate' => [
'description' => 'The time when the domain name expires.'."\n",
'type' => 'string',
'example' => '2017-11-02 04:00:45',
],
'RegistrantType' => [
'description' => 'The registration type of the domain name. Valid values:'."\n"
."\n"
.'* **1**: individual'."\n"
.'* **2**: enterprise'."\n",
'type' => 'string',
'example' => '1',
],
'ExpirationDateLong' => [
'description' => 'The validity period of the domain name. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1522080000000',
],
'ExpirationCurrDateDiff' => [
'description' => 'The number of days from the expiration date of the domain name to the current date.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '-30',
],
'Premium' => [
'description' => 'Indicates whether the domain name is a premium domain name.'."\n",
'type' => 'boolean',
'example' => 'true',
],
'RegistrationDateLong' => [
'description' => 'Indicates how long the domain name has been registered. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1522080000000',
],
'ProductId' => [
'description' => 'The service ID.'."\n",
'type' => 'string',
'example' => '2a',
],
'DomainStatus' => [
'description' => 'The state of the domain name. Valid values:'."\n"
."\n"
.'* **1**: The domain name needs to be renewed.'."\n"
.'* **2**: The domain name needs to be redeemed.'."\n"
.'* **3**: The domain name is normal.'."\n",
'type' => 'string',
'example' => '3',
],
'DomainType' => [
'description' => 'The type of the domain name. Valid values:'."\n"
."\n"
.'* **New gTLD**'."\n"
.'* **gTLD**'."\n"
.'* **ccTLD**'."\n",
'type' => 'string',
'example' => 'gTLD',
],
'ResourceGroupId' => [
'description' => 'The ID of the resource group to which the domain name belongs.'."\n",
'type' => 'string',
'example' => 'rg-aek2yyciz557g3q',
],
'Tag' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => 'The tags added to the resource.'."\n",
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'description' => 'The key of the tag added to the resource.'."\n",
'type' => 'string',
'example' => 'testKey',
],
'Value' => [
'description' => 'The value of the tag added to the resource.'."\n",
'type' => 'string',
'example' => 'testValue',
],
],
],
],
],
],
'Ccompany' => [
'description' => 'The name of the domain name registrant.'."\n",
'type' => 'string',
'example' => 'Guangzhou Forest Advertising Decoration Co., LTD'."\n",
],
'ChgholderStatus' => [
'type' => 'string',
'description' => 'domain transfer status. value:'."\n"
.'- 0: domain status normal.'."\n"
.'- 1: domain is pending change holder.'."\n"
.'- 2: change holder failed.',
'example' => '0',
],
'Registrar' => [
'type' => 'string',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DnsList' => [
'type' => 'array',
'items' => [
'type' => 'string',
],
],
],
],
],
],
],
],
],
'TotalItemNum' => [
'description' => 'The total number of domain names returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NextPage' => [
'description' => 'Indicates whether the current page is followed by a page.'."\n",
'type' => 'boolean',
'example' => 'false',
],
],
'description' => '',
],
],
],
'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' => 'QueryDomainList',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ScrollDomainList' => [
'summary' => 'Traverses domain names.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'EndExpirationDate',
'in' => 'query',
'schema' => [
'description' => 'The end of the time range to query domain names based on expiration dates. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541520000000',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client. Set the value to **127.0.0.1**.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => 'The language of the error message to return if the request fails. Valid values:'."\n"
."\n"
.'* **zh**: Chinese.'."\n"
.'* **en**: English.'."\n"
."\n"
.'Default value: **en**.'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'StartExpirationDate',
'in' => 'query',
'schema' => [
'description' => 'The beginning of the time range to query domain names based on expiration dates. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541520000000',
],
],
[
'name' => 'ProductDomainType',
'in' => 'query',
'schema' => [
'description' => 'The type of the domain name. Valid values:'."\n"
."\n"
.'* **New gTLD**'."\n"
.'* **gTLD**'."\n"
.'* **ccTLD**'."\n"
.'* **other**'."\n",
'type' => 'string',
'required' => false,
'example' => 'gTLD',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of entries per page.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '500',
'minimum' => '1',
'example' => '50',
'default' => '200',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the domain name group. You can call the [QueryDomainGroupList](https://help.aliyun.com/document_detail/69362.html) operation to obtain the ID of the domain name group.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456',
],
],
[
'name' => 'DomainStatus',
'in' => 'query',
'schema' => [
'description' => 'The status of the domain name. Valid values:'."\n"
."\n"
.'* **0**: All.'."\n"
.'* **1**: The domain name needs to be renewed.'."\n"
.'* **2**: The domain name needs to be redeemed.'."\n"
.'* **3**: The domain name is normal.'."\n"
.'* **4**: The domain name is being transferred from Alibaba Cloud.'."\n"
.'* **5**: The information about the domain name registrant is being modified.'."\n"
.'* **6**: Real-name verification is not performed on the domain name.'."\n"
.'* **7**: Real-name verification for the domain name fails. Real-name reverification is required.'."\n"
.'* **8**: The domain name is being reviewed.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'EndLength',
'in' => 'query',
'schema' => [
'description' => 'The end of domain name length to query.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
],
],
[
'name' => 'Excluded',
'in' => 'query',
'schema' => [
'description' => 'The keyword that is used to exclude domain names.'."\n",
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ExcludedPrefix',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to exclude the prefix keyword.'."\n",
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ExcludedSuffix',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to exclude the suffix keyword.'."\n",
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'Form',
'in' => 'query',
'schema' => [
'description' => 'The composition of the domain name.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => [
'description' => 'The keyword.'."\n",
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'KeyWordPrefix',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether the keyword is the prefix.'."\n",
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'KeyWordSuffix',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether the keyword is the suffix.'."\n",
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'StartLength',
'in' => 'query',
'schema' => [
'description' => 'The start of the domain name length to query.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'TradeType',
'in' => 'query',
'schema' => [
'description' => 'The publishing status of the domain name. Valid values:'."\n"
."\n"
.'* **2**: The domain name is published at a fixed price.'."\n"
.'* **3**: The domain name is published with the price negotiable.'."\n"
.'* **4**: The domain name is published for bidding.'."\n"
.'* **6**: The domain name is published with price push.'."\n"
.'* **-1**: The domain name is not published.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'Suffixs',
'in' => 'query',
'schema' => [
'description' => 'The suffixes of domain names to be queried. Separate multiple suffixes with commas (,).'."\n",
'type' => 'string',
'required' => false,
'example' => 'com',
],
],
[
'name' => 'StartRegistrationDate',
'in' => 'query',
'schema' => [
'description' => 'The beginning of the time range to query domain names based on registration dates. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541520000000',
],
],
[
'name' => 'EndRegistrationDate',
'in' => 'query',
'schema' => [
'description' => 'The end of the time range to query domain names based on registration dates. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1541520000000',
],
],
[
'name' => 'ScrollId',
'in' => 'query',
'schema' => [
'description' => 'The scroll ID. This parameter is a technical parameter.'."\n",
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the resource group.'."\n",
'type' => 'string',
'required' => false,
'example' => 'rg-acfmw6bpc6n7zai',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '722AB7F5-61F0-408C-A012-4784AFD34083',
],
'PageSize' => [
'description' => 'The number of entries per page.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '50',
],
'ScrollId' => [
'description' => 'The scroll ID.'."\n",
'type' => 'string',
'example' => 'test',
],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Domain' => [
'description' => 'The domain names.'."\n",
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'DomainAuditStatus' => [
'description' => 'The status of real-name verification for the domain name. Valid values:'."\n"
."\n"
.'* **FAILED**: Real-name verification for the domain name fails.'."\n"
.'* **SUCCEED**: Real-name verification for the domain name is successful.'."\n"
.'* **NONAUDIT**: Real-name verification for the domain name is not performed.'."\n"
.'* **AUDITING**: Real-name verification for the domain name is in progress.'."\n",
'type' => 'string',
'example' => 'NONAUDIT',
],
'DomainGroupId' => [
'description' => 'The ID of the domain name group.'."\n",
'type' => 'string',
'example' => '1234',
],
'Remark' => [
'description' => 'The remarks on the domain name.'."\n",
'type' => 'string',
'example' => 'test domain',
],
'DomainGroupName' => [
'description' => 'The name of the domain name group.'."\n",
'type' => 'string',
'example' => 'test group',
],
'ZhRegistrantOrganization' => [
'description' => 'The Chinese name of the domain name registrant.'."\n",
'type' => 'string',
'example' => '阿里云',
],
'RegistrantOrganization' => [
'description' => 'The registrant of the domain name.'."\n",
'type' => 'string',
'example' => 'alibaba cloud',
],
'RegistrationDate' => [
'description' => 'The time when the domain name was registered.'."\n",
'type' => 'string',
'example' => '2017-02-15 00:00:00',
],
'InstanceId' => [
'description' => 'The instance ID of the domain name.'."\n",
'type' => 'string',
'example' => 'S1234',
],
'DomainName' => [
'description' => 'The domain name.'."\n",
'type' => 'string',
'example' => 'example.com',
],
'ExpirationDateStatus' => [
'description' => 'Indicates whether the domain name expires. Valid values:'."\n"
."\n"
.'* **1**: The domain name does not expire.'."\n"
.'* **2**: The domain name expires.'."\n",
'type' => 'string',
'example' => '1',
],
'ExpirationDate' => [
'description' => 'The time when the domain name expires.'."\n",
'type' => 'string',
'example' => '2019-02-15 17:30:35',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Dns' => [
'description' => 'The Domain Name System (DNS) servers of the domain name.'."\n",
'type' => 'array',
'items' => [
'description' => 'The DNS servers of the domain name.'."\n",
'type' => 'string',
'example' => '["dns15.hichina.com", "dns16.hichina.com"]',
],
],
],
],
'Email' => [
'description' => 'The email address.'."\n",
'type' => 'string',
'example' => 'username@example.com',
],
'RegistrantType' => [
'description' => 'The registration type of the domain name. Valid values:'."\n"
."\n"
.'* **1**: individual.'."\n"
.'* **2**: enterprise.'."\n",
'type' => 'string',
'example' => '1',
],
'ExpirationDateLong' => [
'description' => 'The time when the domain name expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1550223035000',
],
'ExpirationCurrDateDiff' => [
'description' => 'The number of days from the expiration date of the domain name to the current date.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'Premium' => [
'description' => 'Indicates whether the domain name is a premium domain name.'."\n",
'type' => 'boolean',
'example' => 'false',
],
'RegistrationDateLong' => [
'description' => 'The time when the domain name was registered. This value is a UNIX timestamp that indicates the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1487088000000',
],
'ProductId' => [
'description' => 'The service ID.'."\n",
'type' => 'string',
'example' => '2a',
],
'DomainStatus' => [
'description' => 'The status of the domain name. Valid values:'."\n"
."\n"
.'* **1**: The domain name needs to be renewed.'."\n"
.'* **2**: The domain name needs to be redeemed.'."\n"
.'* **3**: The domain name is normal.'."\n"
.'* **4**: The domain name is being transferred out.'."\n"
.'* **5**: The information about the domain name registrant is being modified.'."\n"
.'* **6**: Real-name verification is not performed on the domain name.'."\n"
.'* **7**: Real-name verification for the domain name fails.'."\n"
.'* **8**: The real-name verification is being reviewed.'."\n",
'type' => 'string',
'example' => '3',
],
'DomainType' => [
'description' => 'The type of the domain name. Valid values:'."\n"
."\n"
.'* **New gTLD**'."\n"
.'* **gTLD**'."\n"
.'* **ccTLD**'."\n",
'type' => 'string',
'example' => 'gTLD',
],
'ResourceGroupId' => [
'description' => 'The ID of the resource group.'."\n",
'type' => 'string',
'example' => 'rg-aek2yyciz557g3q',
],
'Tag' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => 'The resource tag.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'description' => 'The tag key.'."\n",
'type' => 'string',
'example' => 'testKey',
],
'Value' => [
'description' => 'The tag value.'."\n",
'type' => 'string',
'example' => 'testValue',
],
],
],
],
],
],
],
],
],
],
],
'TotalItemNum' => [
'description' => 'The number of remaining domain names to be queried.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
],
'description' => '',
],
],
],
'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' => 'ScrollDomainList',
'description' => 'If you have a large number of domain names, a slow response may occur when you call an API operation to query domain names. In this case, you can call this operation to query domain names more quickly. When you call this operation for the first time, specify the request parameters except ScrollId. A scroll ID is returned without other data. In the second request, use the scroll ID obtained from the previous response. In subsequent requests, the newly specified request parameters do not take effect, and the request parameters that are specified in the first request prevail.'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainSuffix' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => 'QueryDomainSuffix',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryAdvancedDomainList' => [
'summary' => 'Searches for domain names by using the advanced search feature.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'EndExpirationDate',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'StartExpirationDate',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'ProductDomainType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'gTLD',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '0',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '200',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '-1',
],
],
[
'name' => 'DomainNameSort',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'DomainStatus',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'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' => 'false',
],
],
[
'name' => 'KeyWordSuffix',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ProductDomainTypeSort',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RegistrationDateSort',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndRegistrationDate',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rg-acfmw6bpc6n7zai',
],
],
[
'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' => '',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 21,
],
],
[
'name' => 'IsPremiumDomain',
'in' => 'query',
'schema' => [
'type' => 'boolean',
],
],
],
'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' => '',
'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' => '',
'type' => 'string',
'example' => '2018-04-09 17:07:03',
],
'InstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'S20182000000000',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'example.com',
],
'ExpirationDateStatus' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'ExpirationDate' => [
'description' => '',
'type' => 'string',
'example' => '2019-04-09 17:07:03',
],
'DnsList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Dns' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'example' => '["dns15.hichina.com", "dns16.hichina.com"]',
],
],
],
],
'Email' => [
'description' => '',
'type' => 'string',
'example' => 'username@example.com',
],
'RegistrantType' => [
'description' => '',
'type' => 'string',
'example' => '1',
],
'ExpirationDateLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1554800823000',
],
'ExpirationCurrDateDiff' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '356',
],
'Premium' => [
'description' => '',
'type' => 'boolean',
'example' => 'false',
],
'RegistrationDateLong' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1523264823000',
],
'ProductId' => [
'description' => '',
'type' => 'string',
'example' => '2a',
],
'DomainStatus' => [
'description' => '',
'type' => 'string',
'example' => '5',
],
'DomainType' => [
'description' => '',
'type' => 'string',
'example' => 'gTLD',
],
'ResourceGroupId' => [
'description' => '',
'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' => '',
],
],
],
],
],
],
],
],
],
],
],
'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' => 'QueryAdvancedDomainList',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'LookupTmchNotice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ClaimKey',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => '2017092100/8/2/1/kDfu9htHGEx_y-LJ3XSlKMZ70000020001',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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"}]',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ClaimKey' => [
'description' => '',
'type' => 'string',
'example' => '2017092100/8/2/1/kDfu9htHGEx_y-LJ3XSlKMZ70000020001',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => 'BA7A4FD4-EB9A-4A20-BB0C-9AEB15634DC1',
],
'Result' => [
'description' => '',
'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' => 'CheckDomainSunriseClaim',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => 'QueryArtExtension',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForCreatingDnsHost' => [
'summary' => '保存创建dns服务器的任务请求',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'S1234567890',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DnsName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'dns1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Ip',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForAddingDSRecord' => [
'summary' => '添加dnsSec记录',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'example.com',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'en',
'required' => false,
'type' => 'string',
'default' => 'en',
],
],
[
'name' => 'KeyTag',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '1',
'format' => 'int32',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '127.0.0.1',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '1',
'format' => 'int32',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'DigestType',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '2',
'format' => 'int32',
'required' => true,
'type' => 'integer',
],
],
[
'name' => 'Digest',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598',
'required' => true,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA',
'type' => 'string',
],
'TaskNo' => [
'description' => '',
'example' => 'e893148f-6343-4ae1-9eba-6e2a4116e142',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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"}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'SaveSingleTaskForDeletingDnsHost' => [
'summary' => '删除DNS HOST任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'S2019270W570xxxx',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DnsName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'dns1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => 'SaveSingleTaskForDeletingDnsHost',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForDeletingDSRecord' => [
'summary' => '删除dnsSec记录',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'KeyTag',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForSynchronizingDnsHost' => [
'summary' => '保存同步dns服务器的任务请求',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'ST2017120814571100001303',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForSynchronizingDSRecord' => [
'summary' => '同步DnsSec记录',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForModifyingDnsHost' => [
'summary' => '保存修改dns服务器的任务请求',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'S123456789',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'en',
'required' => false,
'type' => 'string',
'default' => 'en',
],
],
[
'name' => 'DnsName',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'dns1',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '127.0.0.1',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Ip',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'example' => '218.xx.xx.236',
'items' => [
'description' => '',
'example' => '218.xx.xx.236',
'required' => false,
'type' => 'string',
],
'maxItems' => 13,
'required' => true,
'type' => 'array',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => '0F1B3547-BE50-4206-8F78-9540FFB85BC1',
'type' => 'string',
],
'TaskNo' => [
'description' => '',
'example' => 'e9b8e8b4-7334-4548-9cec-c30b6891f292',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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"}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'SaveSingleTaskForModifyingDSRecord' => [
'summary' => '修改DnsSec记录',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'KeyTag',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'DigestType',
'in' => 'query',
'schema' => [
'description' => '',
'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' => 'SaveSingleTaskForModifyingDSRecord',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForModifyingDomainDns' => [
'summary' => '批量修改dns',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'AliyunDns',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'required' => true,
'example' => 'example.com',
'maxItems' => 1000,
],
],
[
'name' => 'DomainNameServer',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'type' => 'array',
'items' => [
'type' => 'string',
'required' => false,
],
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDnsHost' => [
'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' => 'ST2017120814571100001303',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DnsName' => [
'description' => '',
'type' => 'string',
'example' => 'ns3',
],
'IpList' => [
'type' => 'array',
'items' => [
'description' => '',
'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' => 'QueryDnsHost',
'requestParamsDescription' => ' ',
'responseParamsDescription' => 'QueryDnsHost',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DigestType' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'Digest' => [
'description' => '',
'type' => 'string',
'example' => 'f58fa917424383934c7b0cf1a90f61d692745680fa06f5ecdbe0924e86de9598',
],
'Algorithm' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'KeyTag' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteDomainGroup' => [
'summary' => '删除域名分组',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'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' => 'DeleteDomainGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateDomainToDomainGroup' => [
'summary' => '向分组设置域名',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'FileToUpload',
'in' => 'formData',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dGVzdA==',
],
],
[
'name' => 'DomainGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1234',
],
],
[
'name' => 'Replace',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => true,
'example' => 'false',
],
],
[
'name' => 'DataSource',
'in' => 'query',
'schema' => [
'description' => '',
'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.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' => 'UpdateDomainToDomainGroup',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveDomainGroup' => [
'summary' => '创建/更新域名分组',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryDomainGroupList' => [
'summary' => 'Queries a list of domain name groups.',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'OrderKeyType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'OrderByType',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
],
'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' => '',
'type' => 'boolean',
'example' => 'false',
],
'DomainGroupStatus' => [
'description' => '',
'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' => 'QueryDomainGroupList',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryServerLock' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'en',
'required' => false,
'type' => 'string',
'default' => 'en',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'S20181*****85212',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '127.0.0.1',
'required' => false,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'StartDate' => [
'description' => '',
'example' => '2021-07-10 17:37:36',
'type' => 'string',
],
'GmtCreate' => [
'description' => '',
'example' => '2021-07-10 17:37:36',
'type' => 'string',
],
'RequestId' => [
'description' => '',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
'type' => 'string',
],
'ExpireDate' => [
'description' => '',
'example' => '2030-07-10 17:37:36',
'type' => 'string',
],
'DomainName' => [
'description' => '',
'example' => 'example.com',
'type' => 'string',
],
'UserId' => [
'description' => '',
'example' => '121000000****',
'type' => 'string',
],
'GmtModified' => [
'description' => '',
'example' => '2021-07-10 17:37:36',
'type' => 'string',
],
'DomainInstanceId' => [
'description' => '',
'example' => 'S20190N1DAI4****',
'type' => 'string',
],
'LockInstanceId' => [
'description' => '',
'example' => 'S2021591IQ28****',
'type' => 'string',
],
'ServerLockStatus' => [
'description' => '',
'example' => '2',
'format' => 'int32',
'type' => 'integer',
],
'LockProductId' => [
'description' => '',
'example' => '1807**',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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' => 'QueryServerLock',
],
'CheckProcessingServerLockApply' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'FeePeriod',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'Exists' => [
'description' => '',
'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' => 'CheckProcessingServerLockApply',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'CheckAction',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'activate',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => 'CheckMaxYearOfServerLock',
],
'ListServerLock' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => 'The domain name for which you want to query the enabled registry lock.'."\n",
'type' => 'string',
'required' => false,
'example' => 'example.com',
],
],
[
'name' => 'EndStartDate',
'in' => 'query',
'schema' => [
'description' => 'The end of the time range to query.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2020-07-10 17:37:36',
],
],
[
'name' => 'BeginStartDate',
'in' => 'query',
'schema' => [
'description' => 'The start of the time range to query.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2021-07-10 17:37:36',
],
],
[
'name' => 'PageNum',
'in' => 'query',
'schema' => [
'description' => 'The page number.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of entries per page.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
'default' => '500',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => 'The language of the error message to return if the request fails. Valid values:'."\n"
."\n"
.'* zh: Chinese'."\n"
.'* en: English'."\n"
."\n"
.'Default value: en.'."\n",
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'LockProductId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the product to which the domain name with the registry lock enabled belongs.'."\n",
'type' => 'string',
'required' => false,
'example' => '1807**',
],
],
[
'name' => 'ServerLockStatus',
'in' => 'query',
'schema' => [
'description' => 'The status of the registry lock. Valid values:'."\n"
."\n"
.'* 1: The registry lock is not enabled.'."\n"
.'* 2: The registry lock is enabled.'."\n"
.'* 3: The registry lock is disabled.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'StartExpireDate',
'in' => 'query',
'schema' => [
'description' => 'The start of the expiration time.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2020-07-10 17:37:36',
],
],
[
'name' => 'EndExpireDate',
'in' => 'query',
'schema' => [
'description' => 'The end of the expiration time.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2021-07-10 17:37:36',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'description' => 'The field that you use to sort the query results.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'* EXPIRE_DATE'."\n",
'type' => 'string',
'required' => false,
'example' => 'EXPIRE_DATE',
'enum' => [
'EXPIRE_DATE',
],
],
],
[
'name' => 'OrderByType',
'in' => 'query',
'schema' => [
'description' => 'The order of the information based on which you want to sort the domain names, such as the registration date and expiration date. Valid values: ASC and DESC. The value ASC specifies the ascending order. The value DESC specifies the descending order. If this parameter is not configured, the default value DESC is used.'."\n",
'type' => 'string',
'required' => false,
'example' => 'DESC',
'enum' => [
'DESC',
'ASC',
],
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client. For example, you can set the value to **127.0.0.1**.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PrePage' => [
'description' => 'Indicates whether the current page is preceded by a page.'."\n",
'type' => 'boolean',
'example' => 'false',
],
'CurrentPageNum' => [
'description' => 'The page number.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'PageSize' => [
'description' => 'The number of entries per page.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
'TotalPageNum' => [
'description' => 'The total number of pages returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Data' => [
'description' => 'The response parameters.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ServerLockStatus' => [
'description' => 'The status of the registry lock.'."\n",
'type' => 'string',
'example' => '2',
],
'LockInstanceId' => [
'description' => 'The instance ID of the domain name for which the registry lock is enabled.'."\n",
'type' => 'string',
'example' => 'S2021591IQ28****',
],
'UserId' => [
'description' => 'The user ID.'."\n",
'type' => 'string',
'example' => '121000000****',
],
'GmtCreate' => [
'description' => 'The creation time.'."\n",
'type' => 'string',
'example' => '2020-02-19 16:38:07',
],
'ExpireDate' => [
'description' => 'The expiration time.'."\n",
'type' => 'string',
'example' => '2030-07-10 17:37:36',
],
'StartDate' => [
'description' => 'The start time.'."\n",
'type' => 'string',
'example' => '2021-07-10 17:37:36',
],
'LockProductId' => [
'description' => 'The ID of the product to which the domain name with the registry lock enabled belongs.'."\n",
'type' => 'string',
'example' => '1807**',
],
'DomainInstanceId' => [
'description' => 'The instance ID of the domain name.'."\n",
'type' => 'string',
'example' => 'S20190N1DAI4****',
],
'GmtModified' => [
'description' => 'The time when the domain name was last modified.'."\n",
'type' => 'string',
'example' => '2022-02-19 16:40:38',
],
'DomainName' => [
'description' => 'The domain name that has valid registry lock information.'."\n",
'type' => 'string',
'example' => 'example.com',
],
],
],
],
'TotalItemNum' => [
'description' => 'The total number of entries returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '2',
],
'NextPage' => [
'description' => 'Indicates whether the current page is followed by a page.'."\n",
'type' => 'boolean',
'example' => 'false',
],
],
'description' => '',
],
],
],
'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' => 'ListServerLock',
'summary' => 'Queries information about domain names for which registry locks are enabled.',
],
'SubmitOperationAuditInfo' => [
'summary' => '提交申请信息',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'example.com,example.org',
],
],
[
'name' => 'AuditType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
[
'name' => 'AuditInfo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9DKCF6F8-243C-40EC-8035-4B12FEFD7C22',
],
'Id' => [
'description' => '',
'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' => 'SubmitOperationAuditInfo',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SubmitOperationCredentials' => [
'summary' => '提交证件资料',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'AuditRecordId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RegType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AuditType',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => 'SubmitOperationCredentials',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CancelOperationAudit' => [
'summary' => '取消审核',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'en',
'required' => false,
'type' => 'string',
'default' => 'en',
],
],
[
'name' => 'AuditRecordId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => '1',
'format' => 'int64',
'required' => true,
'type' => 'integer',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => '9KFCF6F8-243C-40EC-8035-4B12KKFD7D90',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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":""}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'CancelOperationAudit',
],
'CancelQualificationVerification' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'knet',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '',
'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' => 'CancelQualificationVerification',
],
'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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => 'ResetQualificationVerification',
],
'SaveRegistrantProfileRealNameVerification' => [
'summary' => '保存联系人模板和凭据',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Country',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'CN',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'RegistrantProfileId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1234567',
],
],
[
'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' => 'Address',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'chao yang qu',
],
],
[
'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' => '1234567',
],
],
[
'name' => 'TelArea',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '86',
],
],
[
'name' => 'Telephone',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '12345678',
],
],
[
'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' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'ZhAddress',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'ZhCity',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '',
],
],
[
'name' => 'RegistrantType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '1',
],
],
[
'name' => 'RegistrantProfileType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'common',
],
],
[
'name' => 'IdentityCredential',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'dGVzdA==',
],
],
[
'name' => 'IdentityCredentialNo',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '4111111111111110**',
],
],
[
'name' => 'IdentityCredentialType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'SFZ',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RegistrantProfileId' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'example' => '1234567',
],
'RequestId' => [
'description' => '',
'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' => 'SaveRegistrantProfileRealNameVerification',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryFailingReasonListForQualification' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
],
'parameters' => [
[
'name' => 'QualificationType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'knet',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => 'QueryFailingReasonListForQualification',
],
'QueryOperationAuditInfoDetail' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'AuditRecordId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'docRequired' => true,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AuditInfo' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'AuditStatus' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '',
'type' => 'string',
'example' => '9DFCF6F8-243C-40EC-8035-4B12FEFD7D1L',
],
'BusinessName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'AuditType' => [
'description' => '',
'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' => '',
'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' => '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' => '',
'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' => '',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AuditStatus',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'BusinessName' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'AuditInfo' => [
'description' => '',
'type' => 'string',
'example' => '',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'example.com,aliyundoc.com',
],
'AuditStatus' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'Id' => [
'description' => '',
'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' => '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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'QualificationType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'knet',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AuditStatus' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'RequestId' => [
'description' => '',
'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' => '',
'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' => 'QueryQualificationDetail',
],
'GetOperationOssUploadPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'AuditType',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '9DFCF6F8-243C-40EC-8035-4B12FEFD7D011',
],
'Accessid' => [
'description' => '',
'type' => 'string',
'example' => 'hObpgEXoca42****',
],
'Signature' => [
'description' => '',
'type' => 'string',
'example' => 'pNVECGkyL0tl4bKXekV5ErZ****',
],
'Host' => [
'description' => 'OSS Endpoint。',
'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' => 'GetOperationOssUploadPolicy',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchTaskForDomainNameProxyService' => [
'summary' => '保存批量任务-开启/关闭whois隐私保护锁',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '127.0.0.1',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'en',
'required' => false,
'type' => 'string',
'default' => 'en',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'false',
'required' => true,
'type' => 'boolean',
],
],
[
'name' => 'DomainName',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'example' => 'test1.com,test2.com,test3.com',
'items' => [
'description' => '',
'example' => 'example.com',
'required' => false,
'type' => 'string',
],
'maxItems' => 1000,
'required' => true,
'type' => 'array',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'F51977F9-2B40-462B-BCCD-CF5BB1E9DB56',
'type' => 'string',
],
'TaskNo' => [
'description' => '',
'example' => 'd3babb0a-c939-4c25-8c65-c47b65f54923',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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":""}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
],
'SaveSingleTaskForDomainNameProxyService' => [
'summary' => '保存单个任务-开启/关闭whois隐私保护锁',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => 'SaveSingleTaskForDomainNameProxyService',
],
'SaveTaskForSubmittingDomainDelete' => [
'summary' => '保存删除域名的任务',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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' => 'SaveTaskForSubmittingDomainDelete',
],
'SaveSingleTaskForAssociatingEns' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForDisassociatingEns' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveBatchDomainRemark' => [
'summary' => '批量保存域名备注信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'S12344567',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => 'SaveBatchDomainRemark',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SaveSingleTaskForSaveArtExtension' => [
'summary' => '保存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' => '',
'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' => '',
'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' => 'SaveSingleTaskForSaveArtExtension',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryChangeLogList' => [
'summary' => 'Queries the operations logs of a domain name.',
'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' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1522080000000',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '2017-12-26 12:00:00',
],
'Result' => [
'description' => '',
'type' => 'string',
'example' => 'Failed',
],
'DomainName' => [
'description' => '',
'type' => 'string',
'example' => 'example.com',
],
'OperationIPAddress' => [
'description' => '',
'type' => 'string',
'example' => '127.0.0.1',
],
'Details' => [
'description' => '',
'type' => 'string',
'example' => 'dns1;dns2 -> dns3;dns4',
],
'Remark' => [
'type' => 'string',
],
],
],
],
],
],
'ResultLimit' => [
'description' => '',
'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' => 'QueryChangeLogList',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryLocalEnsAssociation' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Address' => [
'description' => '',
'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"}]',
'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' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Address' => [
'description' => '',
'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"}]',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetQualificationUploadPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'en',
'default' => 'en',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'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' => '',
'type' => 'string',
'example' => '9DFCF6F8-243C-****-8035-4B12FEFD7D48',
],
'Accessid' => [
'description' => '',
'type' => 'string',
'example' => 'hObpgEXoca42****',
],
'Signature' => [
'description' => '',
'type' => 'string',
'example' => 'pNVECGkyL0tl4bKXekV5ErZ****',
],
'Host' => [
'description' => '',
'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' => 'GetQualificationUploadPolicy',
],
'ChangeResourceGroup' => [
'summary' => 'ChangeResourceGroup',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'zh',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'S20227H17A561968',
],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'docRequired' => false,
'example' => 'rg-aek2tcx7os7bkmq',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'Domain',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '4EA05A10-D4BC-47EA-AD9E-370A46BB4FB9',
],
'Result' => [
'description' => '',
'type' => 'string',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4EA05A10-D4BC-47EA-AD9E-370A46BB4FB9\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]',
'title' => 'ChangeResourceGroup',
],
'SaveBatchTaskForReserveDropListDomain' => [
'summary' => 'Submits a task to reserve multiple domain names that are provided by HiChina.',
'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' => '',
'docRequired' => true,
'example' => '123123',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'Domains',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '',
'items' => [
'properties' => [
'DomainName' => [
'description' => '',
'example' => 'example.com',
'required' => true,
'type' => 'string',
],
'Dns1' => [
'type' => 'string',
],
'Dns2' => [
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'maxItems' => 5000,
'required' => true,
'type' => 'array',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'B7AB5469-5E38-4AA9-A920-C65B7A9C8E6E',
'type' => 'string',
],
'TaskNo' => [
'description' => '',
'example' => '3cb1adc3-20e8-44ae-9e76-e812fa6fc9d8',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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' => 'SaveBatchTaskForReserveDropListDomain',
],
'QueryIntlFixedPriceOrderList' => [
'summary' => 'Queries the list of fixed-price orders at the international site (alibabacloud.com).',
'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' => '',
'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' => '',
'type' => 'string',
'example' => 'D6CB3623-4726-4947-AC2B-2C6E673B447C',
],
'Module' => [
'description' => '',
'type' => 'object',
'properties' => [
'TotalItemNum' => [
'type' => 'integer',
'format' => 'int32',
],
'CurrentPageNum' => [
'type' => 'integer',
'format' => 'int32',
],
'PageSize' => [
'type' => 'integer',
'format' => 'int32',
],
'TotalPageNum' => [
'type' => 'integer',
'format' => 'int32',
],
'Data' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OrderType' => [
'type' => 'integer',
'format' => 'int32',
],
'BizId' => [
'type' => 'string',
],
'UserId' => [
'type' => 'string',
],
'Status' => [
'type' => 'integer',
'format' => 'int32',
],
'Price' => [
'type' => 'integer',
'format' => 'int64',
],
'Domain' => [
'type' => 'string',
],
'CreateTime' => [
'type' => 'integer',
'format' => 'int64',
],
'UpdateTime' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
],
],
],
'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' => 'QueryIntlFixedPriceOrderList',
],
'CheckIntlFixPriceDomainStatus' => [
'summary' => 'Checks the domain name status and price inquiries of a fixed-price order at the international site (alibabacloud.com).',
'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' => '',
'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' => '',
'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' => '',
'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' => 'CheckIntlFixPriceDomainStatus',
],
'CreateIntlFixedPriceDomainOrder' => [
'summary' => 'Creates a fixed-price order at the international site (alibabacloud.com).',
'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' => '',
'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' => '',
'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' => '',
'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' => '',
'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' => 'CreateIntlFixedPriceDomainOrder',
],
'GetIntlFixPriceDomainListUrl' => [
'summary' => 'Queries the list of domain names for fixed-price orders at the international site (alibabacloud.com).',
'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' => 'The date when the list is exported.'."\n",
'type' => 'string',
'required' => false,
'example' => '20240809',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response'."\n",
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => 'BF014B60-C708-4253-B5F2-3F9B493F398B',
],
'Module' => [
'description' => 'The returned data.'."\n",
'type' => 'object',
'properties' => [
'DownloadUrl' => [
'description' => 'The URL for downloading the list that contains available fixed-price domain names at the international site (alibabacloud.com).'."\n",
'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' => 'GetIntlFixPriceDomainListUrl',
],
'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' => 'The business ID.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '3666'."\n",
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO',
'description' => 'PopResultDTO\\'."\n",
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '096DCF79-A89A-5CED-B7DE-1B04761023B9',
],
'HttpStatusCode' => [
'description' => 'The HTTP status code that is directly returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'DynamicCode' => [
'description' => 'The dynamic error code.'."\n",
'type' => 'string',
'example' => '-',
],
'DynamicMessage' => [
'description' => 'The dynamic error message.'."\n",
'type' => 'string',
'example' => '-',
],
'Synchro' => [
'description' => 'Indicates whether to perform synchronous processing.'."\n",
'type' => 'boolean',
'example' => 'True',
],
'ErrorMsg' => [
'description' => 'The error message.'."\n",
'type' => 'string',
'example' => '110001',
],
'ErrorCode' => [
'description' => 'The error code.'."\n",
'type' => 'string',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values: true and false.'."\n",
'type' => 'boolean',
'example' => 'True',
],
'Module' => [
'description' => 'The returned data.'."\n",
'type' => 'any',
'example' => '-',
],
'AllowRetry' => [
'description' => 'Indicates whether retries are allowed.'."\n",
'type' => 'boolean',
'example' => 'False',
],
'ErrorArgs' => [
'description' => 'The array of error parameters that are returned.'."\n",
'type' => 'array',
'items' => [
'description' => 'The error parameter that is returned.'."\n",
'type' => 'any',
'example' => '-',
],
],
'AppName' => [
'description' => 'The name of the application for which the error code is returned.'."\n",
'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' => 'DomainSpecialBizCancel',
],
'SubmitDomainSpecialBizCredentials' => [
'summary' => '域名特殊业务提交资料',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'BizId',
'in' => 'formData',
'schema' => [
'description' => 'The business ID.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '219',
],
],
[
'name' => 'Credentials',
'in' => 'formData',
'schema' => [
'description' => 'The certificate information.'."\n",
'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' => 'The extended information.'."\n",
'type' => 'string',
'required' => false,
'example' => '{\\"addTransferLock\\":true}',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO',
'description' => 'PopResultDTO\\'."\n",
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => 'A83E1D74-E46B-505C-947A-8C6B7E41C011'."\n",
],
'HttpStatusCode' => [
'description' => 'The HTTP status code that is directly returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200'."\n",
],
'DynamicCode' => [
'description' => 'The dynamic error code.'."\n",
'type' => 'string',
'example' => '-',
],
'DynamicMessage' => [
'description' => 'The dynamic error message.'."\n",
'type' => 'string',
'example' => '-',
],
'Synchro' => [
'description' => 'Indicates whether to perform synchronous processing.'."\n",
'type' => 'boolean',
'example' => 'True',
],
'ErrorMsg' => [
'description' => 'The error message.'."\n",
'type' => 'string',
'example' => '110001',
],
'ErrorCode' => [
'description' => 'The error code.'."\n",
'type' => 'string',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'example' => 'True',
],
'Module' => [
'description' => 'The returned data.'."\n",
'type' => 'any',
'example' => '-',
],
'AllowRetry' => [
'description' => 'Indicates whether retries are allowed.'."\n",
'type' => 'boolean',
'example' => 'False',
],
'ErrorArgs' => [
'description' => 'The array of error parameters that are returned.'."\n",
'type' => 'array',
'items' => [
'description' => 'The error parameter that is returned.'."\n",
'type' => 'any',
'example' => '-',
],
],
'AppName' => [
'description' => 'The name of the application for which the error code is returned.'."\n",
'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' => 'SubmitDomainSpecialBizCredentials',
],
'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' => 'The domain name.'."\n",
'type' => 'string',
'required' => true,
'example' => 'test003.cn',
],
],
[
'name' => 'BizType',
'in' => 'formData',
'schema' => [
'title' => '业务类型',
'description' => 'The business type.'."\n",
'type' => 'string',
'required' => true,
'example' => 'govRegister',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO',
'description' => 'PopResultDTO'."\n",
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '97663DFF-D24D-55AE-A577-6CC5AF20B732',
],
'HttpStatusCode' => [
'description' => 'The HTTP status code that is directly returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'DynamicCode' => [
'description' => 'The dynamic error code.'."\n",
'type' => 'string',
'example' => '-',
],
'DynamicMessage' => [
'description' => 'The dynamic error message.'."\n",
'type' => 'string',
'example' => '-',
],
'Synchro' => [
'description' => 'Indicates whether to perform synchronous processing.'."\n",
'type' => 'boolean',
'example' => 'true',
],
'ErrorMsg' => [
'description' => 'The error message.'."\n",
'type' => 'string',
'example' => '110001'."\n",
],
'ErrorCode' => [
'description' => 'The error code.'."\n",
'type' => 'string',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values: true and false'."\n",
'type' => 'boolean',
'example' => 'True',
],
'Module' => [
'description' => 'The returned data.'."\n",
'type' => 'object',
'properties' => [
'Id' => [
'title' => '主键',
'description' => 'The primary key.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '34083',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => 'The time when the business was created.'."\n",
'type' => 'string',
'example' => '2023-03-21 15:10:04.0'."\n",
],
'GmtModified' => [
'title' => '修改时间',
'description' => 'The time when the business was modified.'."\n",
'type' => 'string',
'example' => '2023-03-21 15:10:04.0'."\n",
],
'BizName' => [
'title' => '业务名称',
'description' => 'The business name.'."\n",
'type' => 'string',
'example' => '',
],
'BizNo' => [
'title' => '业务编号',
'description' => 'The business ID.'."\n",
'type' => 'string',
'example' => 'A83E1D74-E46B-505C-947A-8C6B7E41C012'."\n",
],
'DomainName' => [
'title' => '域名',
'description' => 'The domain name.'."\n",
'type' => 'string',
'example' => 'test003.cn'."\n",
],
'SaleId' => [
'title' => '实例ID',
'description' => 'The instance ID.'."\n",
'type' => 'string',
'example' => 'S20172315BJ37809'."\n",
],
'UserId' => [
'title' => '用户ID',
'description' => 'The user ID.'."\n",
'type' => 'string',
'example' => '121000000****'."\n",
],
'ProductId' => [
'title' => '产品id',
'description' => 'The service ID.'."\n",
'type' => 'string',
'example' => '1',
],
'BizType' => [
'title' => '业务类型',
'description' => 'The business type.'."\n",
'type' => 'string',
'example' => 'govRegister'."\n",
],
'BizStatus' => [
'title' => '业务状态',
'description' => 'The business status.'."\n",
'type' => 'string',
'example' => 'REGISTRANT_VSP_AUDIT_SUCCESS'."\n",
],
'Status' => [
'title' => '业务状态(用户前端使用)',
'description' => 'The business status.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'StatusDesc' => [
'title' => '业务状态描述(用户前端使用)',
'description' => 'The description of business status.'."\n",
'type' => 'string',
'example' => '',
],
'AuditMsg' => [
'title' => '审核信息',
'description' => 'The review information.'."\n",
'type' => 'string',
'example' => '',
],
'OrderId' => [
'title' => '订单id',
'description' => 'The order ID.'."\n",
'type' => 'string',
'example' => '123',
],
'UpdateTime' => [
'title' => '更新时间',
'description' => 'The time when the business was updated.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '2020-11-17 18:11:15'."\n",
],
'CreateTime' => [
'title' => '创建时间',
'description' => 'The time when the business was created.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '2023-01-17 11:31:10'."\n",
],
'DomainSpecialBizContact' => [
'title' => '联系人信息',
'description' => 'The contact information.'."\n",
'type' => 'object',
'properties' => [
'BizId' => [
'title' => '业务id',
'description' => 'The business ID.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '258'."\n",
],
'RegType' => [
'title' => '类型:1-个人 ,2-企业',
'description' => 'The contact type. Valid values: 1: individual. 2: enterprise.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CCompany' => [
'title' => '组织名称',
'description' => 'The organization name.'."\n",
'type' => 'string',
'example' => '',
],
'ECompany' => [
'title' => '组织名称(英文)',
'description' => 'The organization name in English.'."\n",
'type' => 'string',
'example' => 'hebeihuiheguandaozhizaoyouxiangongsi'."\n",
],
'CName' => [
'title' => '联系人姓名',
'description' => 'The contact name.'."\n",
'type' => 'string',
'example' => '',
],
'EName' => [
'title' => '联系人姓名(英文)',
'description' => 'The contact name in English.'."\n",
'type' => 'string',
'example' => 'tong da wei',
],
'CCountry' => [
'title' => '国家代码',
'description' => 'The country code.'."\n",
'type' => 'string',
'example' => 'CN',
],
'CProvince' => [
'title' => '省份',
'description' => 'The province.'."\n",
'type' => 'string',
'example' => '',
],
'EProvince' => [
'title' => '省份(英文)',
'description' => 'The province in English.'."\n",
'type' => 'string',
'example' => 'liao ning',
],
'CCity' => [
'title' => '城市',
'description' => 'The city.'."\n",
'type' => 'string',
'example' => '',
],
'ECity' => [
'title' => '城市(英文)',
'description' => 'The city in English.'."\n",
'type' => 'string',
'example' => 'an shan Shi',
],
'CVenu' => [
'title' => '地址',
'description' => 'The address.'."\n",
'type' => 'string',
'example' => '',
],
'EVenu' => [
'title' => '地址(英文)',
'description' => 'The address in English.'."\n",
'type' => 'string',
'example' => 'tie xi qu xin kai jie 59-4 hao',
],
'Postalcode' => [
'title' => '邮编',
'description' => 'The zip code.'."\n",
'type' => 'string',
'example' => '100000'."\n",
],
'Email' => [
'title' => '电子邮箱',
'description' => 'The email address.'."\n",
'type' => 'string',
'example' => 'username@example.com'."\n",
],
'TelArea' => [
'title' => '电话国家代码',
'description' => 'The calling code of the country or region where the domain name contact is located.'."\n",
'type' => 'string',
'example' => '86',
],
'TelMain' => [
'title' => '区号固定电话或手机号码',
'description' => 'The landline number with an area code or mobile number.'."\n",
'type' => 'string',
'example' => '16604121234',
],
'TelExt' => [
'title' => '电话分机号',
'description' => 'The telephone extension number.'."\n",
'type' => 'string',
'example' => '2756',
],
'FaxArea' => [
'title' => '传真国家代码',
'description' => 'The fax country code.'."\n",
'type' => 'string',
'example' => '86'."\n",
],
'FaxMain' => [
'title' => '区号传真号或手机号码',
'description' => 'The fax number with an area code or mobile number.'."\n",
'type' => 'string',
'example' => '16604121234'."\n",
],
'FaxExt' => [
'title' => '传真分机号',
'description' => 'The fax extension number.'."\n",
'type' => 'string',
'example' => '61284565'."\n",
],
'Mobile' => [
'title' => '手机号码',
'description' => 'The mobile number.'."\n",
'type' => 'string',
'example' => '156********'."\n",
],
'Extend' => [
'title' => '扩展信息',
'description' => 'The extended information.'."\n",
'type' => 'string',
'example' => '-',
],
'VspContactId' => [
'title' => 'vsp联系人id',
'description' => 'The VSP contact ID.'."\n",
'type' => 'string',
'example' => '121000001****'."\n",
],
'RegistrantId' => [
'title' => '持有者id',
'description' => 'The registrant ID.'."\n",
'type' => 'string',
'example' => '121000002****'."\n",
],
],
],
'DomainSpecialBizCredentials' => [
'title' => '证件信息',
'description' => 'The certificate information.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DomainName' => [
'title' => '域名',
'description' => 'The domain name.'."\n",
'type' => 'string',
'example' => 'test003.cn'."\n",
],
'SaleId' => [
'title' => '实例ID',
'description' => 'The instance ID.'."\n",
'type' => 'string',
'example' => 'S20172315BJ37809'."\n",
],
'BizId' => [
'title' => '关联流程ID',
'description' => 'The ID of the associated workflow.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => 'T20220831150014000001'."\n",
],
'CredentialNo' => [
'title' => '证件号',
'description' => 'The certificate number.'."\n",
'type' => 'string',
'example' => '4111111111111110**'."\n",
],
'CredentialType' => [
'title' => '证件类型',
'description' => 'The certificate type.'."\n",
'type' => 'string',
'example' => 'SFZ'."\n",
],
'CredentialUrl' => [
'title' => '证件url',
'description' => 'The certificate URL.'."\n",
'type' => 'string',
'example' => 'http://test.oss-cn-hangzhou.aliyuncs.com/20170522/1219541161213057_070445190.jpg',
],
'HolderCert' => [
'title' => '是否持有者证件',
'description' => 'Indicates whether the certificate belongs to the registrant.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
],
],
'AllowRetry' => [
'description' => 'Indicates whether retries are allowed.'."\n",
'type' => 'boolean',
'example' => 'False',
],
'ErrorArgs' => [
'description' => 'The array of error parameters that are returned.'."\n",
'type' => 'array',
'items' => [
'description' => 'The error parameter that is returned.'."\n",
'type' => 'any',
'example' => '-',
],
],
'AppName' => [
'description' => 'The name of the application for which the error code is returned.'."\n",
'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' => 'QueryDomainSpecialBizInfoByDomain',
],
'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' => 'The business ID.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
],
[
'name' => 'UserClientIp',
'in' => 'query',
'schema' => [
'description' => 'The IP address of the client.'."\n",
'type' => 'string',
'required' => false,
'example' => '127.0.0.1',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PopResultDTO',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => 'A83E1D74-E46B-505C-947A-8C6B7E41C011',
],
'HttpStatusCode' => [
'description' => 'The HTTP status code that is directly returned.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '200',
],
'DynamicCode' => [
'description' => 'The dynamic error code.'."\n",
'type' => 'string',
'example' => '-',
],
'DynamicMessage' => [
'description' => 'The dynamic error message.'."\n",
'type' => 'string',
'example' => '-',
],
'Synchro' => [
'description' => 'Indicates whether to perform synchronous processing.'."\n",
'type' => 'boolean',
'example' => 'true',
],
'ErrorMsg' => [
'description' => 'The error message.'."\n",
'type' => 'string',
'example' => '110001',
],
'ErrorCode' => [
'description' => 'The error code.'."\n",
'type' => 'string',
'example' => '',
],
'Success' => [
'description' => 'Indicates whether the request is successful. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n",
'type' => 'boolean',
'example' => 'True',
],
'Module' => [
'description' => 'The returned data.'."\n",
'type' => 'object',
'properties' => [
'Id' => [
'title' => '主键',
'description' => 'The primary key.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '34083',
],
'GmtCreate' => [
'title' => '创建时间',
'description' => 'The time when the business was created.'."\n",
'type' => 'string',
'example' => '2023-03-21 15:10:04.0',
],
'GmtModified' => [
'title' => '修改时间',
'description' => 'The time when the business was modified.'."\n",
'type' => 'string',
'example' => '2023-03-21 15:10:04.0',
],
'BizName' => [
'title' => '业务名称',
'description' => 'The business name.'."\n",
'type' => 'string',
'example' => '',
],
'BizNo' => [
'title' => '业务编号',
'description' => 'The business ID.'."\n",
'type' => 'string',
'example' => 'A83E1D74-E46B-505C-947A-8C6B7E41C012',
],
'DomainName' => [
'title' => '域名',
'description' => 'The domain name.'."\n",
'type' => 'string',
'example' => 'test003.cn',
],
'SaleId' => [
'title' => '实例ID',
'description' => 'The instance ID.'."\n",
'type' => 'string',
'example' => 'S20172315BJ37809',
],
'UserId' => [
'title' => '用户ID',
'description' => 'The user ID.'."\n",
'type' => 'string',
'example' => '121000000****',
],
'ProductId' => [
'title' => '产品id',
'description' => 'The service ID.'."\n",
'type' => 'string',
'example' => '1',
],
'BizType' => [
'title' => '业务类型',
'description' => 'The business type.'."\n",
'type' => 'string',
'example' => 'govRegister',
],
'BizStatus' => [
'title' => '业务状态',
'description' => 'The business status.'."\n",
'type' => 'string',
'example' => 'REGISTRANT_VSP_AUDIT_SUCCESS',
],
'Status' => [
'title' => '业务状态(用户前端使用)',
'description' => 'The business status.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'StatusDesc' => [
'title' => '业务状态描述(用户前端使用)',
'description' => 'The description of business status.'."\n",
'type' => 'string',
'example' => '',
],
'AuditMsg' => [
'title' => '审核信息',
'description' => 'The review information.'."\n",
'type' => 'string',
'example' => '',
],
'OrderId' => [
'title' => '订单id',
'description' => 'The order ID.'."\n",
'type' => 'string',
'example' => '123',
],
'UpdateTime' => [
'title' => '更新时间',
'description' => 'The time when the business was updated.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '2020-11-17 18:11:15',
],
'CreateTime' => [
'title' => '创建时间',
'description' => 'The time when the business was created.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '2023-01-17 11:31:10',
],
'DomainSpecialBizContact' => [
'title' => '联系人信息',
'description' => 'The contact information.'."\n",
'type' => 'object',
'properties' => [
'BizId' => [
'title' => '业务id',
'description' => 'The business ID.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '258',
],
'RegType' => [
'title' => '类型:1-个人 ,2-企业',
'description' => 'The contact type. Valid values: 1: individual. 2: enterprise.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'CCompany' => [
'title' => '组织名称',
'description' => 'The organization name.'."\n",
'type' => 'string',
'example' => '',
],
'ECompany' => [
'title' => '组织名称(英文)',
'description' => 'The organization name in English.'."\n",
'type' => 'string',
'example' => 'hebeihuiheguandaozhizaoyouxiangongsi',
],
'CName' => [
'title' => '联系人姓名',
'description' => 'The contact name.'."\n",
'type' => 'string',
'example' => '',
],
'EName' => [
'title' => '联系人姓名(英文)',
'description' => 'The contact name in English.'."\n",
'type' => 'string',
'example' => 'tong da wei',
],
'CCountry' => [
'title' => '国家代码',
'description' => 'The country code.'."\n",
'type' => 'string',
'example' => 'CN',
],
'CProvince' => [
'title' => '省份',
'description' => 'The province.'."\n",
'type' => 'string',
'example' => '',
],
'EProvince' => [
'title' => '省份(英文)',
'description' => 'The province in English.'."\n",
'type' => 'string',
'example' => 'liao ning',
],
'CCity' => [
'title' => '城市',
'description' => 'The city.'."\n",
'type' => 'string',
'example' => '',
],
'ECity' => [
'title' => '城市(英文)',
'description' => 'The city in English.'."\n",
'type' => 'string',
'example' => 'an shan Shi',
],
'CVenu' => [
'title' => '地址',
'description' => 'The address.'."\n",
'type' => 'string',
'example' => '',
],
'EVenu' => [
'title' => '地址(英文)',
'description' => 'The address in English.'."\n",
'type' => 'string',
'example' => 'tie xi qu xin kai jie 59-4 hao',
],
'Postalcode' => [
'title' => '邮编',
'description' => 'The zip code.'."\n",
'type' => 'string',
'example' => '100000',
],
'Email' => [
'title' => '电子邮箱',
'description' => 'The email address.'."\n",
'type' => 'string',
'example' => 'username@example.com',
],
'TelArea' => [
'title' => '电话国家代码',
'description' => 'The calling code of the country or region where the domain name contact is located.'."\n",
'type' => 'string',
'example' => '86',
],
'TelMain' => [
'title' => '区号固定电话或手机号码',
'description' => 'The landline number with an area code or mobile number.'."\n",
'type' => 'string',
'example' => '16604121234',
],
'TelExt' => [
'title' => '电话分机号',
'description' => 'The telephone extension number.'."\n",
'type' => 'string',
'example' => '61284565',
],
'FaxArea' => [
'title' => '传真国家代码',
'description' => 'The fax country code.'."\n",
'type' => 'string',
'example' => '86',
],
'FaxMain' => [
'title' => '区号传真号或手机号码',
'description' => 'The fax number with an area code or mobile number.'."\n",
'type' => 'string',
'example' => '16604121234',
],
'FaxExt' => [
'title' => '传真分机号',
'description' => 'The fax extension number.'."\n",
'type' => 'string',
'example' => '61284565',
],
'Mobile' => [
'title' => '手机号码',
'description' => 'The mobile number.'."\n",
'type' => 'string',
'example' => '156********',
],
'Extend' => [
'title' => '扩展信息',
'description' => 'The extended information.'."\n",
'type' => 'string',
'example' => '-',
],
'VspContactId' => [
'title' => 'vsp联系人id',
'description' => 'The VSP contact ID.'."\n",
'type' => 'string',
'example' => '121000001****',
],
'RegistrantId' => [
'title' => '持有者id',
'description' => 'The registrant ID.'."\n",
'type' => 'string',
'example' => '121000002****',
],
],
],
'DomainSpecialBizCredentials' => [
'title' => '证件信息',
'description' => 'The certificate information.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DomainName' => [
'title' => '域名',
'description' => 'The domain name.'."\n",
'type' => 'string',
'example' => 'test003.cn',
],
'SaleId' => [
'title' => '实例ID',
'description' => 'The instance ID.'."\n",
'type' => 'string',
'example' => 'S20172315BJ37809',
],
'BizId' => [
'title' => '关联流程ID',
'description' => 'The ID of the associated workflow.'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => 'T20220831150014000001',
],
'CredentialNo' => [
'title' => '证件号',
'description' => 'The certificate number.'."\n",
'type' => 'string',
'example' => '4111111111111110**',
],
'CredentialType' => [
'title' => '证件类型',
'description' => 'The certificate type.'."\n",
'type' => 'string',
'example' => 'SFZ',
],
'CredentialUrl' => [
'title' => '证件url',
'description' => 'The certificate URL.'."\n",
'type' => 'string',
'example' => 'http://test.oss-cn-hangzhou.aliyuncs.com/20170522/1219541161213057_070445190.jpg',
],
'HolderCert' => [
'title' => '是否持有者证件',
'description' => 'Indicates whether the certificate belongs to the registrant.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'DomainSpecialOrderResult' => [
'description' => 'The information about the order.'."\n",
'type' => 'object',
'properties' => [
'SaleId' => [
'description' => 'The instance ID.'."\n",
'type' => 'string',
'example' => 'S201601063418719',
],
'OrderId' => [
'description' => 'The order ID.'."\n",
'type' => 'string',
'example' => 'S201601060123456',
],
'SubOrderId' => [
'description' => 'The suborder ID.'."\n",
'type' => 'string',
'example' => 'S201601061234567',
],
'ActionType' => [
'description' => 'The cost type.'."\n",
'type' => 'string',
'example' => 'activate',
],
'OrderAmount' => [
'description' => 'The amount of the order.'."\n",
'type' => 'number',
'format' => 'double',
'example' => '0.0',
],
'OrderCurrency' => [
'description' => 'The currency.'."\n",
'type' => 'string',
'example' => 'CNY',
],
'OrderTime' => [
'description' => 'The time when the order was placed.'."\n",
'type' => 'string',
'example' => '2023-09-19T14:28Z',
],
'OrderYear' => [
'description' => 'The validity period.'."\n",
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'OrderStatus' => [
'description' => 'The order status.'."\n",
'type' => 'string',
'example' => 'ORDER_WAIT_PAY',
],
],
],
],
],
'AllowRetry' => [
'description' => 'Indicates whether retries are allowed.'."\n",
'type' => 'boolean',
'example' => 'False',
],
'ErrorArgs' => [
'description' => 'The array of error parameters that are returned.'."\n",
'type' => 'array',
'items' => [
'description' => 'The error parameter that is returned.'."\n",
'type' => 'any',
'example' => '-',
],
],
'AppName' => [
'description' => 'The name of the application for which the error code is returned.'."\n",
'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' => 'QueryDomainSpecialBizDetail',
],
'SaveBatchTaskForTransferOutByAuthorizationCode' => [
'summary' => 'Submits multiple transfer-out tasks based on the transfer keys of domain names.',
'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,
'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' => 'SaveBatchTaskForTransferOutByAuthorizationCode',
],
'SaveSingleTaskForTransferOutByAuthorizationCode' => [
'summary' => 'Submits a single transfer-out task based on the transfer key of a domain name.',
'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' => 'The transfer key.'."\n",
'type' => 'string',
'required' => true,
'example' => 'example.com',
],
],
[
'name' => 'AuthorizationCode',
'in' => 'query',
'schema' => [
'description' => 'Schema of Response'."\n",
'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' => 'The request ID.'."\n",
'type' => 'string',
'example' => 'C560A803-B975-481D-A66B-A4395EA863A1',
],
'TaskNo' => [
'description' => 'The task ID.'."\n",
'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' => 'SaveSingleTaskForTransferOutByAuthorizationCode',
'description' => 'The task ID.'."\n",
],
],
'endpoints' => [
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'domain.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'domain-intl.aliyuncs.com',
],
],
];