'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'Domain', 'version' => '2016-05-11', ], 'directories' => [ [ 'id' => 0, 'title' => '其它', 'type' => 'directory', 'children' => [ 'CheckDomain', 'DeleteContactTemplate', 'QueryBatchTaskDetailList', 'QueryBatchTaskList', 'QueryContact', 'QueryDomainBySaleId', 'QueryContactTemplate', 'QueryDomainList', 'QueryFailReasonList', 'SaveContactTemplateCredential', 'SaveContactTemplate', 'SaveTaskForModifyingDomainDns', 'SaveTaskForSubmittingDomainNameCredential', 'SaveTaskForSubmittingDomainNameCredentialByTemplateId', 'SaveTaskForUpdatingContactByTempateId', 'SaveTaskForUpdatingContactByTemplateId', 'WhoisProtection', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CheckDomain' => [ 'summary' => '域名检查', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'FeeFee' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'Avail' => [ 'type' => 'integer', 'format' => 'int32', ], 'RmbFee' => [ 'type' => 'string', ], 'FeeCommand' => [ 'type' => 'string', ], 'FeePeriod' => [ 'type' => 'integer', 'format' => 'int32', ], 'Reason' => [ 'type' => 'string', ], 'FeeCurrency' => [ 'type' => 'string', ], 'Name' => [ 'type' => 'string', ], ], ], ], ], 'responseDemo' => null, ], 'DeleteContactTemplate' => [ 'summary' => '删除联系人模板', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'ContactTemplateId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'QueryBatchTaskDetailList' => [ 'summary' => '查询任务详情列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'TaskNo', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'SaleId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'TaskStatus', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PrePage' => [ 'type' => 'boolean', ], 'CurrentPageNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'RequestId' => [ 'type' => 'string', ], 'PageSize' => [ 'type' => 'integer', 'format' => 'int32', ], 'TotalPageNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TaskDetail' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TaskType' => [ 'type' => 'string', ], 'TaskNo' => [ 'type' => 'string', ], 'UpdateTime' => [ 'type' => 'string', ], 'TaskStatus' => [ 'type' => 'string', ], 'TryCount' => [ 'type' => 'integer', 'format' => 'int32', ], 'ErrorMsg' => [ 'type' => 'string', ], 'DomainName' => [ 'type' => 'string', ], ], ], ], ], ], 'TotalItemNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'NextPage' => [ 'type' => 'boolean', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'QueryBatchTaskList' => [ 'summary' => '查询任务列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'BeginCreateTime', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'EndCreateTime', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PrePage' => [ 'type' => 'boolean', ], 'CurrentPageNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'RequestId' => [ 'type' => 'string', ], 'PageSize' => [ 'type' => 'integer', 'format' => 'int32', ], 'TotalPageNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TaskInfo' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TaskType' => [ 'type' => 'string', ], 'TaskNo' => [ 'type' => 'string', ], 'TaskStatus' => [ 'type' => 'string', ], 'TaskNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'CreateTime' => [ 'type' => 'string', ], 'Clientip' => [ 'type' => 'string', ], ], ], ], ], ], 'TotalItemNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'NextPage' => [ 'type' => 'boolean', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'QueryContact' => [ 'summary' => '查询联系人', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], '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' => 'ContactType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'CVenu' => [ 'type' => 'string', ], 'EName' => [ 'type' => 'string', ], 'Email' => [ 'type' => 'string', ], 'RequestId' => [ 'type' => 'string', ], 'RegType' => [ 'type' => 'string', ], 'EProvince' => [ 'type' => 'string', ], 'ECompany' => [ 'type' => 'string', ], 'PostalCode' => [ 'type' => 'string', ], 'CCountry' => [ 'type' => 'string', ], 'CreateDate' => [ 'type' => 'string', ], 'EVenu' => [ 'type' => 'string', ], 'TelMain' => [ 'type' => 'string', ], 'UpdateDate' => [ 'type' => 'string', ], 'CCompany' => [ 'type' => 'string', ], 'CProvince' => [ 'type' => 'string', ], 'CName' => [ 'type' => 'string', ], 'ECity' => [ 'type' => 'string', ], 'CCity' => [ 'type' => 'string', ], 'TelExt' => [ 'type' => 'string', ], 'TelArea' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'QueryDomainBySaleId' => [ 'summary' => '根据saleId查询域名信息', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'SaleId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'ChineseHolder' => [ 'type' => 'string', ], 'CreationDate' => [ 'type' => 'string', ], 'DomainName' => [ 'type' => 'string', ], 'SaleId' => [ 'type' => 'string', ], 'Premium' => [ 'type' => 'boolean', ], 'HolderEmail' => [ 'type' => 'string', ], 'DomainRegType' => [ 'type' => 'string', ], 'EnglishHolder' => [ 'type' => 'string', ], 'Remark' => [ 'type' => 'string', ], 'EnglishContactPerson' => [ 'type' => 'string', ], 'TransferLock' => [ 'type' => 'string', ], 'DnsList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Dns' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], ], ], ], 'TransferOutStatus' => [ 'type' => 'string', ], 'ExpirationDate' => [ 'type' => 'string', ], 'UserId' => [ 'type' => 'string', ], 'SafetyLock' => [ 'type' => 'string', ], 'ChineseContactPerson' => [ 'type' => 'string', ], 'EmailVerificationClientHold' => [ 'type' => 'boolean', ], 'EmailVerificationStatus' => [ 'type' => 'integer', 'format' => 'int32', ], 'WhoisProtected' => [ 'type' => 'boolean', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'QueryContactTemplate' => [ 'summary' => '查询联系人模板', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'CCompany', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ECompany', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ContactTemplateId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], ], [ 'name' => 'DefaultTemplate', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, ], ], [ 'name' => 'AuditStatus', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'RegType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '500', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PrePage' => [ 'type' => 'boolean', ], 'CurrentPageNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'RequestId' => [ 'type' => 'string', ], 'PageSize' => [ 'type' => 'integer', 'format' => 'int32', ], 'TotalPageNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'TotalItemNum' => [ 'type' => 'integer', 'format' => 'int32', ], 'NextPage' => [ 'type' => 'boolean', ], 'ContactTemplates' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ContactTemplate' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CCountry' => [ 'type' => 'string', ], 'TelExt' => [ 'type' => 'string', ], 'UpdateTime' => [ 'type' => 'string', ], 'RegType' => [ 'type' => 'string', ], 'CreateTime' => [ 'type' => 'string', ], 'EProvince' => [ 'type' => 'string', ], 'UserId' => [ 'type' => 'string', ], 'CVenu' => [ 'type' => 'string', ], 'TelArea' => [ 'type' => 'string', ], 'ContactTemplateId' => [ 'type' => 'integer', 'format' => 'int64', ], 'AuditStatus' => [ 'type' => 'string', ], 'CProvince' => [ 'type' => 'string', ], 'PostalCode' => [ 'type' => 'string', ], 'CCity' => [ 'type' => 'string', ], 'EVenu' => [ 'type' => 'string', ], 'ECompany' => [ 'type' => 'string', ], 'CCompany' => [ 'type' => 'string', ], 'EName' => [ 'type' => 'string', ], 'TelMain' => [ 'type' => 'string', ], 'Email' => [ 'type' => 'string', ], 'DefaultTemplate' => [ 'type' => 'boolean', ], 'EmailVerificationStatus' => [ 'type' => 'integer', 'format' => 'int32', ], 'ECity' => [ 'type' => 'string', ], 'CName' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'QueryDomainList' => [ 'summary' => '查询域名列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], '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. en: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', 'default' => 'en', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => [ 'description' => 'The group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '123', ], ], [ 'name' => 'QueryType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the query. Valid values:'."\n" ."\n" .'1: renewal. 2: redemption. 4: transfer.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query based on the time when domain names expire.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-01-01 00:00:00', ], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query based on the time when domain names expire.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-01-11 00:00:00', ], ], [ 'name' => 'DeadStartDate', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query based on the time when domain names expire.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1694016000000', ], ], [ 'name' => 'DeadEndDate', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query based on the time when domain names expire.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1696435200000', ], ], [ 'name' => 'RegStartDate', 'in' => 'query', 'schema' => [ 'description' => 'The beginning of the time range to query based on the time when domain names were registered.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1694016000000', ], ], [ 'name' => 'RegEndDate', 'in' => 'query', 'schema' => [ 'description' => 'The end of the time range to query based on the time when domain names were registered.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1696435200000', ], ], [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'description' => 'The domain name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test003.cn', ], ], [ 'name' => 'OrderByType', 'in' => 'query', 'schema' => [ 'description' => 'The order in which you want to sort the queried domain names. Valid values:'."\n" ."\n" .'ASC: ascending order. DESC: descending order.'."\n", 'type' => 'string', 'required' => false, 'example' => 'DESC', ], ], [ 'name' => 'OrderKeyType', 'in' => 'query', 'schema' => [ 'description' => 'The field by which domain names to be queried are sorted. Valid values:'."\n" ."\n" .'REGDATE: registration time. DEADDATE: expiration time. CREATEDATE: creation time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'REGDATE', ], ], [ 'name' => 'DomainType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the domain name. Valid values:'."\n" ."\n" .'GUOJI, TONGYONG, GUONEI, NAME, and WEIBO.'."\n", 'type' => 'string', 'required' => false, 'example' => 'GUONEI', ], ], [ 'name' => 'ProductDomainType', 'in' => 'query', 'schema' => [ 'description' => 'The product type of the domain name. Valid values:'."\n" ."\n" .'New gTLD, gTLD, ccTLD, and other.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ccTLD', ], ], [ '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', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PrePage' => [ 'description' => 'Indicates whether the current page follows another page.'."\n", 'type' => 'boolean', 'example' => 'false', ], 'CurrentPageNum' => [ 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], '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' => '10', ], 'TotalPageNum' => [ 'description' => 'The total number of pages.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Domain' => [ 'description' => 'The returned results.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DomainAuditStatus' => [ 'description' => 'The review status of the domain name.'."\n", 'type' => 'string', 'example' => 'SUCCEED', ], 'RegDateLong' => [ 'description' => 'The time when the domain name was registered.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1696435200000', ], 'Remark' => [ 'description' => 'The remarks.'."\n", 'type' => 'string', 'example' => '-', ], 'DeadDateLong' => [ 'description' => 'The time when the domain name expires.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1696435200000', ], 'SaleId' => [ 'description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'S20172315BJ37809', ], 'DomainName' => [ 'description' => 'The domain name.'."\n", 'type' => 'string', 'example' => 'test003.cn', ], 'DeadDate' => [ 'description' => 'The time when the domain name expires.'."\n", 'type' => 'string', 'example' => '2024-03-16 02:20:34', ], 'GroupId' => [ 'description' => 'The group ID.'."\n", 'type' => 'string', 'example' => '123', ], 'DomainRegType' => [ 'description' => 'The registration type of the domain name. Valid values:'."\n" ."\n" .'PERSONAL: individual. COMPANY: enterprise.'."\n", 'type' => 'string', 'example' => 'COMPANY', ], 'RegDate' => [ 'description' => 'The time when the domain name was registered.'."\n", 'type' => 'string', 'example' => '2023-03-16 02:20:35', ], 'Premium' => [ 'description' => 'Indicates whether the domain name is a premium domain name.'."\n", 'type' => 'boolean', 'example' => 'falese', ], 'ProductId' => [ 'description' => 'The product ID.'."\n", 'type' => 'string', 'example' => '123', ], 'DomainStatus' => [ 'description' => 'The status of the domain name. Valid values:'."\n" ."\n" .'1: The domain name needs to be renewed. 2: The domain name needs to be redeemed. 3: The domain name is normal. 4: The domain name is being transferred from HiChina. 5: The information about the domain name registrant is being modified. 6: Real-name verification is not performed on the domain name. 7: Real-name verification for the domain name fails. Real-name reverification is required. 8: The domain name is being reviewed.'."\n", 'type' => 'string', 'example' => '1', ], 'DeadDateStatus' => [ 'description' => 'The expiration status of the domain name. Valid values:'."\n" ."\n" .'1: unexpired. 2: expired.'."\n", 'type' => 'string', 'example' => '1', ], 'DomainType' => [ 'description' => 'The type of the domain name. Valid values:'."\n" ."\n" .'New gTLD gTLD ccTLD other'."\n", 'type' => 'string', 'example' => 'gTLD', ], ], ], ], ], ], 'TotalItemNum' => [ 'description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'NextPage' => [ 'description' => 'Indicates whether the current page is followed by a page.'."\n", 'type' => 'boolean', 'example' => 'true', ], ], 'description' => '', ], ], ], 'staticInfo' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PrePage\\": false,\\n \\"CurrentPageNum\\": 1,\\n \\"RequestId\\": \\"9DFCF6F8-243C-****-8035-4B12FEFD7D48\\",\\n \\"PageSize\\": 10,\\n \\"TotalPageNum\\": 5,\\n \\"Data\\": {\\n \\"Domain\\": [\\n {\\n \\"DomainAuditStatus\\": \\"SUCCEED\\",\\n \\"RegDateLong\\": 1696435200000,\\n \\"Remark\\": \\"-\\",\\n \\"DeadDateLong\\": 1696435200000,\\n \\"SaleId\\": \\"S20172315BJ37809\\",\\n \\"DomainName\\": \\"test003.cn\\",\\n \\"DeadDate\\": \\"2024-03-16 02:20:34\\",\\n \\"GroupId\\": \\"123\\",\\n \\"DomainRegType\\": \\"COMPANY\\",\\n \\"RegDate\\": \\"2023-03-16 02:20:35\\",\\n \\"Premium\\": true,\\n \\"ProductId\\": \\"123\\",\\n \\"DomainStatus\\": \\"1\\",\\n \\"DeadDateStatus\\": \\"1\\",\\n \\"DomainType\\": \\"gTLD\\"\\n }\\n ]\\n },\\n \\"TotalItemNum\\": 100,\\n \\"NextPage\\": true\\n}","type":"json"}]', 'title' => '查询域名列表', ], 'QueryFailReasonList' => [ 'summary' => '查询失败原因列表', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'systemTags' => [ 'operationType' => 'list', ], 'parameters' => [ [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'ContactTemplateId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], ], [ 'name' => 'DomainName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'SaleId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'FailRecord' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Date' => [ 'type' => 'string', ], 'FailReason' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'SaveContactTemplateCredential' => [ 'summary' => '保存联系人模板实名资料', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'ContactTemplateId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, ], ], [ 'name' => 'Credential', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'CredentialNo', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'SaveContactTemplate' => [ 'summary' => '保存联系人模板', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'ContactTemplateId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => false, ], ], [ 'name' => 'DefaultTemplate', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, ], ], [ 'name' => 'CCity', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'CCompany', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'CCountry', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'CName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'CProvince', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'CVenu', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ECity', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ECompany', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'EName', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'EProvince', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'EVenu', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'PostalCode', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'TelArea', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'TelMain', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'TelExt', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'RegType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'ContactTemplateId' => [ 'type' => 'integer', 'format' => 'int64', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'SaveTaskForModifyingDomainDns' => [ 'summary' => '修改域名dns任务,对外开放接口，用于domain中', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], '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' => false, ], ], [ 'name' => 'SaleId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'AliyunDns', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => true, ], ], [ 'name' => 'DnsList', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'string', ], 'required' => false, 'maxItems' => 13, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'TaskNo' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'SaveTaskForSubmittingDomainNameCredential' => [ 'summary' => '保存域名实名资料任务', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], '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, 'docRequired' => true, ], ], [ 'name' => 'SaleId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Credential', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'CredentialNo', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, 'docRequired' => true, ], ], [ 'name' => 'CredentialType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'SFZ', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'TaskNo' => [ 'type' => 'string', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'SaveTaskForSubmittingDomainNameCredentialByTemplateId' => [ 'summary' => '根据模板保存域名的实名认证信息', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], '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' => 'SaleId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ContactTemplateId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'TaskNo' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'SaveTaskForUpdatingContactByTempateId' => [ 'summary' => '保存修改联系人的任务', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], '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' => 'SaleId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ContactTemplateId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, ], ], [ 'name' => 'ContactType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'AddTransferLock', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'TaskNo' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'SaveTaskForUpdatingContactByTemplateId' => [ 'summary' => '保存修改联系人的任务', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], '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' => 'SaleId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ContactTemplateId', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int64', 'required' => true, ], ], [ 'name' => 'ContactType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'AddTransferLock', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => false, 'default' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'TaskNo' => [ 'type' => 'string', ], 'Success' => [ 'type' => 'boolean', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], 'WhoisProtection' => [ 'summary' => '开启或者关闭whois保护', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [], 'parameters' => [ [ 'name' => 'UserClientIp', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Lang', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'en', ], ], [ 'name' => 'DataSource', 'in' => 'query', 'schema' => [ 'type' => 'integer', 'format' => 'int32', 'required' => true, ], ], [ 'name' => 'DataContent', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => true, ], ], [ 'name' => 'WhoisProtect', 'in' => 'query', 'schema' => [ 'type' => 'boolean', 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'type' => 'string', ], 'Result' => [ 'type' => 'integer', 'format' => 'int32', ], ], ], ], ], 'staticInfo' => [], 'responseDemo' => null, ], ], 'endpoints' => [ [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'domain.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'domain-intl.aliyuncs.com', ], ], ];