diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/domain/2018-02-08 | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/domain/2018-02-08')
| -rw-r--r-- | data/en_us/domain/2018-02-08/api-docs.php | 746 |
1 files changed, 746 insertions, 0 deletions
diff --git a/data/en_us/domain/2018-02-08/api-docs.php b/data/en_us/domain/2018-02-08/api-docs.php new file mode 100644 index 0000000..c709a65 --- /dev/null +++ b/data/en_us/domain/2018-02-08/api-docs.php @@ -0,0 +1,746 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Domain', + 'version' => '2018-02-08', + ], + 'directories' => [ + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'QueryBrokerDemand', + 'CreateFixedPriceSelectedOrder', + 'CheckSelectedDomainStatus', + 'SelectedDomainList', + 'QueryExchangeRate', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'QueryBrokerDemand' => [ + 'summary' => 'Queries the details of requests.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'APP' => [], + ], + [ + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'enum' => [ + '1', + '2', + '3', + '4', + '5', + '6', + '7', + '8', + '9', + ], + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '10', + 'example' => '20', + 'default' => '10', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SE20183915FI0178', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'CurrentPageNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPageNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '497F7522-82B0-4BD4-84FE-AE8749E4C2F9', + ], + 'TotalItemNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'DemandPrice' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'BizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SE20183915FI0178', + ], + 'BargainSellerMobile' => [ + 'description' => '', + 'type' => 'string', + 'example' => '13300000001', + ], + 'PublishTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1524800053000', + ], + 'ProduceType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DemandDomain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'taobao.com', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Mobile' => [ + 'description' => '', + 'type' => 'string', + 'example' => '13300000000', + ], + 'ServicePayPrice' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '18800', + ], + 'PayPrice' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'PayTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1524800053000', + ], + 'BargainSellerPrice' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'float', + 'example' => '100', + ], + 'OrderType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PayDomain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'test.com', + ], + 'AuditStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PartnerDomain' => [ + 'type' => 'string', + ], + 'PurchaseStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Email' => [ + 'type' => 'string', + ], + 'SettleBasePrice' => [ + 'type' => 'number', + 'format' => 'float', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterIllegall', + 'errorMessage' => 'The specified parameter is not valid.', + ], + [ + 'errorCode' => 'Forbidden.RAM', + 'errorMessage' => 'The user has no resource authorization, or the API does not support ram.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"CurrentPageNum\\": 1,\\n \\"TotalPageNum\\": 15,\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"497F7522-82B0-4BD4-84FE-AE8749E4C2F9\\",\\n \\"TotalItemNum\\": 333,\\n \\"Data\\": [\\n {\\n \\"Status\\": \\"1\\",\\n \\"DemandPrice\\": 1,\\n \\"BizId\\": \\"T20230428100121000101\\",\\n \\"BargainSellerMobile\\": \\"13300000001\\",\\n \\"PublishTime\\": 1524800053000,\\n \\"ProduceType\\": 1,\\n \\"DemandDomain\\": \\"taobao.com\\",\\n \\"Description\\": \\"我要淘宝\\",\\n \\"Mobile\\": \\"13300000000\\",\\n \\"ServicePayPrice\\": 18800,\\n \\"PayPrice\\": 100,\\n \\"PayTime\\": 1524800053000,\\n \\"BargainSellerPrice\\": 100,\\n \\"OrderType\\": 1,\\n \\"PayDomain\\": \\"test.com\\",\\n \\"AuditStatus\\": 1,\\n \\"PartnerDomain\\": \\"test.com\\\\n\\",\\n \\"PurchaseStatus\\": 1,\\n \\"Email\\": \\"[email protected]\\",\\n \\"SettleBasePrice\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryBrokerDemand', + ], + 'CreateFixedPriceSelectedOrder' => [ + 'summary' => '一口价严选下单购买接口,阿里云账户余额直接扣费', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREdomain3EBBI7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DomainName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + 'docRequired' => true, + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'DX123456', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'partnername', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '11935401', + 'docRequired' => true, + ], + ], + [ + 'name' => 'ExpectedPrice', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'required' => true, + 'example' => '20.00', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PopResultDTO<PayUrlResult>', + 'description' => 'PopResultDTO<PayUrlResult>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'C50E41A0-09F1-4491-8DB8-AF55BD2D0CC8', + ], + 'Module' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'OrderNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '31199295f2074ce895645d386cb22c36', + ], + 'Domain' => [ + 'title' => '域名', + 'description' => '', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Price' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20.00', + ], + 'DomainBlockTrade' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'BizIds' => [ + 'title' => '业务ID映射', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '业务ID映射', + 'type' => 'string', + 'example' => '{"test.com":"T2023122019031400****"}', + ], + ], + ], + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'ErrorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DomainNotOnSale', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InsufficientAccountBalance', + 'errorMessage' => 'Aliyun account balance is insufficient, unable to submit strictly selected domain name purchase.', + ], + [ + 'errorCode' => 'UnexpectedRealPrice', + 'errorMessage' => 'When placing an order, the selling price of the domain name does not match the expectation.', + ], + [ + 'errorCode' => 'DomainNotOnSale', + 'errorMessage' => 'The domain name is not currently for sale.', + ], + [ + 'errorCode' => 'NotSelectedDomain', + 'errorMessage' => 'The domain name is not strictly selected goods.', + ], + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Parameter error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C50E41A0-09F1-4491-8DB8-AF55BD2D0CC8\\",\\n \\"Module\\": {\\n \\"OrderNo\\": \\"31199295f2074ce895645d386cb22c36\\",\\n \\"Domain\\": \\"example.com\\",\\n \\"Price\\": 20,\\n \\"DomainBlockTrade\\": [\\n \\"test.com\\"\\n ],\\n \\"BizIds\\": {\\n \\"key\\": \\"T2023122019031400****\\"\\n }\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorCode\\": \\"DomainNotOnSale\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CheckSelectedDomainStatus' => [ + 'summary' => '一口价严选询价接口', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'example.com', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PopResultDTO<FixedPriceDomainVo>', + 'description' => 'PopResultDTO<FixedPriceDomainVo>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E2598CAF-DBFE-494E-95EF-B42A33C178AA', + ], + 'ErrorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OssFileNotFound', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Module' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Price' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '20.00', + ], + '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' => [ + 'title' => '是否为溢价词域名,true是false否', + 'type' => 'boolean', + ], + ], + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NotSelectedDomain', + 'errorMessage' => 'The domain name is not strictly selected goods.', + ], + [ + 'errorCode' => 'DomainNotOnSale', + 'errorMessage' => 'The domain name is not currently for sale.', + ], + [ + 'errorCode' => 'ParameterError', + 'errorMessage' => 'Parameter error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E2598CAF-DBFE-494E-95EF-B42A33C178AA\\",\\n \\"ErrorCode\\": \\"OssFileNotFound\\",\\n \\"Success\\": true,\\n \\"Module\\": {\\n \\"Domain\\": \\"example.com\\",\\n \\"Price\\": 20,\\n \\"RegDate\\": 1566353497,\\n \\"DeadDate\\": 1567353497,\\n \\"EndTime\\": 1567353497,\\n \\"Premium\\": true\\n },\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + ], + 'SelectedDomainList' => [ + 'summary' => '严选列表导出,明日凌晨2点前生成文件,导出凌晨1点前所有在售严选域名', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ListDate', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '20231109', + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '80011ABC-F573-4795-B0E8-377BFBBA3422', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + 'ErrorCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OssFileNotFound', + ], + 'Module' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DownloadUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://selected-domain.oss-cn-zhangjiakou.aliyuncs.com/aliyun_selected_domain_20231109.gz?Expires=1699524493&OSSAccessKeyId=LTAI5tPMAybR4gfSEjdfAk1F&Signature=2Tpo7Eaf%2BqIop8SuMtI91m%2FAFpY%3D', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SelectedListFileNotFound', + 'errorMessage' => 'Selected domain list file not found, possibly because the list has not been generated yet. It is usually completed before 2 am.', + ], + [ + 'errorCode' => 'InputIllegal', + 'errorMessage' => 'The input date is not the current day or the input format is not as expected (the example input is "20231109", which must be the current day of the call date).', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"80011ABC-F573-4795-B0E8-377BFBBA3422\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"OssFileNotFound\\",\\n \\"Module\\": {\\n \\"DownloadUrl\\": \\"http://selected-domain.oss-cn-zhangjiakou.aliyuncs.com/aliyun_selected_domain_20231109.gz?Expires=1699524493&OSSAccessKeyId=LTAI5tPMAybR4gfSEjdfAk1F&Signature=2Tpo7Eaf%2BqIop8SuMtI91m%2FAFpY%3D\\"\\n }\\n}","type":"json"}]', + ], + 'QueryExchangeRate' => [ + 'summary' => '查询汇率', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FromCurrency', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'USD', + ], + ], + [ + 'name' => 'ToCurrency', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'CNY', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'ExchangeRate' => [ + 'description' => '', + 'type' => 'number', + 'format' => 'double', + 'example' => '7.12', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'D200000-C0B9-4CD3-B92A-9B44A000000', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ExchangeRate\\": 7.12,\\n \\"RequestId\\": \\"D200000-C0B9-4CD3-B92A-9B44A000000\\"\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'domain.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'domain-intl.aliyuncs.com', + ], + ], +]; |
