summaryrefslogtreecommitdiff
path: root/data/en_us/httpdns/2016-02-01
diff options
context:
space:
mode:
Diffstat (limited to 'data/en_us/httpdns/2016-02-01')
-rw-r--r--data/en_us/httpdns/2016-02-01/api-docs.php1013
1 files changed, 465 insertions, 548 deletions
diff --git a/data/en_us/httpdns/2016-02-01/api-docs.php b/data/en_us/httpdns/2016-02-01/api-docs.php
index 2ece364..dc24bb8 100644
--- a/data/en_us/httpdns/2016-02-01/api-docs.php
+++ b/data/en_us/httpdns/2016-02-01/api-docs.php
@@ -1,41 +1,15 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Httpdns',
- 'version' => '2016-02-01',
- ],
- 'directories' => [
- [
- 'id' => 0,
- 'title' => '其它',
- 'type' => 'directory',
- 'children' => [
- 'AddDomain',
- 'DeleteDomain',
- 'DescribeDomains',
- 'GetAccountInfo',
- 'GetResolveCountSummary',
- 'GetResolveStatistics',
- 'ListDomains',
- 'RefreshResolveCache',
- ],
- ],
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Httpdns', 'version' => '2016-02-01'],
+ 'directories' => ['AddDomain', 'DeleteDomain', 'DescribeDomains', 'GetAccountInfo', 'GetResolveCountSummary', 'GetResolveStatistics', 'ListDomains', 'RefreshResolveCache'],
'components' => [
'schemas' => [],
],
'apis' => [
'AddDomain' => [
- 'summary' => '添加域名',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Adds a domain name.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -43,33 +17,17 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AccountId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456',
- 'default' => '',
- ],
+ 'schema' => ['description' => 'The HTTPDNS account ID.', 'type' => 'string', 'required' => false, 'default' => '', 'example' => '123456', 'title' => ''],
],
[
'name' => 'DomainName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'www.example.com',
- ],
+ 'schema' => ['description' => 'The domain name.', 'type' => 'string', 'required' => true, 'example' => 'www.example.com', 'title' => ''],
],
],
'responses' => [
@@ -77,35 +35,41 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'DomainName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'www.example.com',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ADA27798-6911-4B06-AF34-53F62F62XXXX',
- ],
+ 'DomainName' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ADA27798-6911-4B06-AF34-53F62F62XXXX', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"www.example.com\\",\\n \\"RequestId\\": \\"ADA27798-6911-4B06-AF34-53F62F62XXXX\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<AddDomainResponse>\\n <RequestId>ADA27798-6911-4B06-AF34-53F62F624D7B</RequestId>\\n <DomainName>www.aliyun.com</DomainName>\\n</AddDomainResponse>","errorExample":""}]',
+ 'title' => 'Add a domain name',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DeleteDomain' => [
- 'summary' => '删除域名',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'httpdns:AddDomain',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/{#DomainName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainName\\": \\"www.example.com\\",\\n \\"RequestId\\": \\"ADA27798-6911-4B06-AF34-53F62F62XXXX\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteDomain' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -113,32 +77,17 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AccountId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12****',
- 'default' => '',
- ],
+ 'schema' => ['description' => 'The HTTPDNS account ID.', 'type' => 'string', 'required' => false, 'default' => '', 'example' => '12****', 'title' => ''],
],
[
'name' => 'DomainName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'www.example.com',
- ],
+ 'schema' => ['description' => 'The domain name.', 'type' => 'string', 'required' => true, 'example' => 'www.example.com', 'title' => ''],
],
],
'responses' => [
@@ -146,34 +95,42 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'DomainName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'www.example.com',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FA8C2599-362D-4113-8FB4-E88A40C2****',
- ],
+ 'DomainName' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FA8C2599-362D-4113-8FB4-E88A40C2****', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"DomainName\\": \\"www.example.com\\",\\n \\"RequestId\\": \\"FA8C2599-362D-4113-8FB4-E88A40C2****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<DeleteDomainResponse>\\n <RequestId>FA8C2599-362D-4113-8FB4-E88A40C2639D</RequestId>\\n <DomainName>www.aliyun.com</DomainName>\\n</DeleteDomainResponse>","errorExample":""}]',
+ 'title' => 'Delete a domain name',
+ 'summary' => 'Deletes a domain name based on the specified parameters.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'DescribeDomains' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'httpdns:DeleteDomain',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/{#DomainName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DomainName\\": \\"www.example.com\\",\\n \\"RequestId\\": \\"FA8C2599-362D-4113-8FB4-E88A40C2****\\"\\n}","type":"json"}]',
+ ],
+ 'DescribeDomains' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -185,108 +142,83 @@
[
'name' => 'AccountId',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '123456',
- 'required' => false,
- 'type' => 'string',
- 'default' => '',
- ],
+ 'schema' => ['description' => 'The HTTPDNS account ID.', 'type' => 'string', 'required' => false, 'default' => '', 'example' => '123456', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'minimum' => '1',
- 'required' => false,
- 'type' => 'integer',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The current page number. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '10',
- 'format' => 'int64',
- 'maximum' => '100',
- 'minimum' => '1',
- 'required' => false,
- 'type' => 'integer',
- 'default' => '20',
- ],
+ 'schema' => ['description' => 'The number of entries per page for a paged query. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'description' => 'The request result.',
+ 'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'example' => '20',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'RequestId' => [
- 'description' => '',
- 'example' => 'A6B3BB61-69CB-50E0-9DC0-0C1658D44A47',
- 'type' => 'string',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'example' => '12',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
+ 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A6B3BB61-69CB-50E0-9DC0-0C1658D44A47', 'title' => ''],
+ 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
'Domains' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Domain' => [
- 'description' => '',
+ 'description' => 'The domain name list.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'The domain name information.',
+ 'type' => 'object',
'properties' => [
- 'DomainName' => [
- 'description' => '',
- 'example' => 'www.aliyun.com',
- 'type' => 'string',
- ],
+ 'DomainName' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'www.aliyun.com', 'title' => ''],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"A6B3BB61-69CB-50E0-9DC0-0C1658D44A47\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 12,\\n \\"Domains\\": {\\n \\"Domain\\": [\\n {\\n \\"DomainName\\": \\"www.aliyun.com\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDomainsResponse>\\n <PageSize>20</PageSize>\\n <RequestId>A6B3BB61-69CB-50E0-9DC0-0C1658D44A47</RequestId>\\n <PageNumber>1</PageNumber>\\n <TotalCount>12</TotalCount>\\n <Domains>\\n <DomainName>www.aliyun.com</DomainName>\\n </Domains>\\n</DescribeDomainsResponse>","errorExample":""}]',
- ],
- 'GetAccountInfo' => [
- 'summary' => '获取用户信息包含配置项',
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'List domain names of a user',
+ 'summary' => 'Lists the domain names of a user based on the specified parameters.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'httpdns:DescribeDomains',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 20,\\n \\"RequestId\\": \\"A6B3BB61-69CB-50E0-9DC0-0C1658D44A47\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 12,\\n \\"Domains\\": {\\n \\"Domain\\": [\\n {\\n \\"DomainName\\": \\"www.aliyun.com\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetAccountInfo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -298,9 +230,7 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREemasRC3OWB',
- ],
+ 'abilityTreeNodes' => ['FEATUREemasRC3OWB'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -308,116 +238,72 @@
'responses' => [
200 => [
'schema' => [
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => '50F9C40E-188D-4208-BE2C-74271337****',
- 'type' => 'string',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50F9C40E-188D-4208-BE2C-74271337****', 'title' => ''],
'AccountInfo' => [
- 'description' => '',
+ 'description' => 'The current account information.',
+ 'type' => 'object',
'properties' => [
- 'SignSecret' => [
- 'description' => '',
- 'example' => '50F9C40E****',
- 'type' => 'string',
- ],
- 'SignedCount' => [
- 'description' => '',
- 'example' => '611523',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'PackageCount' => [
- 'description' => '',
- 'example' => '0',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'MonthResolveCount' => [
- 'description' => '',
- 'example' => '9927326',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'AccountId' => [
- 'description' => '',
- 'example' => '1337****',
- 'type' => 'string',
- ],
- 'UnsignedEnabled' => [
- 'description' => '',
- 'example' => 'true',
- 'type' => 'boolean',
- ],
- 'UserStatus' => [
- 'description' => '',
- 'example' => '1',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'UnsignedCount' => [
- 'description' => '',
- 'example' => '1523',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'MonthHttpsResolveCount' => [
- 'description' => '',
- 'example' => '3',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'MonthFreeCount' => [
- 'description' => '',
- 'example' => '1500000',
- 'format' => 'int32',
- 'type' => 'integer',
- ],
- 'DohEnabled' => [
- 'type' => 'boolean',
- ],
- 'DohResolveAllEnabled' => [
- 'type' => 'boolean',
- ],
- 'MonthDohResolveCount' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'MonthHttpAesResolveCount' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'MonthHttpsAesResolveCount' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'SignSecret' => ['description' => 'The signing secret.', 'type' => 'string', 'example' => '50F9C40E****', 'title' => ''],
+ 'SignedCount' => ['description' => 'The number of authenticated API requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '611523', 'title' => ''],
+ 'PackageCount' => ['description' => 'The number of resource plans. This is a legacy field and is always 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''],
+ 'MonthResolveCount' => ['description' => 'The total number of HTTP-type resolutions for the current month.', 'type' => 'integer', 'format' => 'int32', 'example' => '9927326', 'title' => ''],
+ 'AccountId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '1337****', 'title' => ''],
+ 'UnsignedEnabled' => ['description' => 'Indicates whether the non-authenticated API is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'UserStatus' => ['description' => 'The HTTPDNS account status code. Valid values:'."\n"
+ .'- 1: Normal.'."\n"
+ .'- 2: The account has an overdue payment.'."\n"
+ .'- 3: The account is suspended.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'UnsignedCount' => ['description' => 'The number of non-authenticated API requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '1523', 'title' => ''],
+ 'MonthHttpsResolveCount' => ['description' => 'The total number of HTTPS-type resolutions for the current month.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
+ 'MonthFreeCount' => ['description' => 'The number of free resolutions per month.'."\n"
+ ."\n"
+ .'This is the number of times you can call the HTTPDNS service for domain name resolution free of charge in each calendar year month.', 'type' => 'integer', 'format' => 'int32', 'example' => '1500000', 'title' => ''],
+ 'DohEnabled' => ['description' => 'Indicates whether the DNS over HTTPS (DoH) feature is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'DohResolveAllEnabled' => ['description' => 'Indicates whether DoH resolution for all domain names is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'MonthDohResolveCount' => ['description' => 'The number of DoH resolutions for the current month.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''],
+ 'MonthHttpAesResolveCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'MonthHttpsAesResolveCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50F9C40E-188D-4208-BE2C-74271337****\\",\\n \\"AccountInfo\\": {\\n \\"SignSecret\\": \\"50F9C40E****\\",\\n \\"SignedCount\\": 611523,\\n \\"PackageCount\\": 0,\\n \\"MonthResolveCount\\": 9927326,\\n \\"AccountId\\": \\"1337****\\",\\n \\"UnsignedEnabled\\": true,\\n \\"UserStatus\\": 1,\\n \\"UnsignedCount\\": 1523,\\n \\"MonthHttpsResolveCount\\": 3,\\n \\"MonthFreeCount\\": 1500000,\\n \\"DohEnabled\\": true,\\n \\"DohResolveAllEnabled\\": true,\\n \\"MonthDohResolveCount\\": 10000,\\n \\"MonthHttpAesResolveCount\\": 0,\\n \\"MonthHttpsAesResolveCount\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAccountInfoResponse>\\n <RequestId>50F9C40E-188D-4208-BE2C-74271337****</RequestId>\\n <AccountInfo>\\n <SignSecret>50F9C40E****</SignSecret>\\n <SignedCount>611523</SignedCount>\\n <PackageCount>0</PackageCount>\\n <MonthResolveCount>9927326</MonthResolveCount>\\n <AccountId>1337****</AccountId>\\n <UnsignedEnabled>true</UnsignedEnabled>\\n <UserStatus>1</UserStatus>\\n <UnsignedCount>1523</UnsignedCount>\\n <MonthHttpsResolveCount>3</MonthHttpsResolveCount>\\n <MonthFreeCount>1500000</MonthFreeCount>\\n </AccountInfo>\\n</GetAccountInfoResponse>","errorExample":""}]',
- 'extraInfo' => ' ',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Retrieve account information',
+ 'summary' => 'Retrieves the current HTTPDNS account information.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
- ],
- 'GetResolveCountSummary' => [
- 'summary' => '解析次数概览',
- 'methods' => [
- 'post',
- 'get',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'httpdns:GetAccountInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50F9C40E-188D-4208-BE2C-74271337****\\",\\n \\"AccountInfo\\": {\\n \\"SignSecret\\": \\"50F9C40E****\\",\\n \\"SignedCount\\": 611523,\\n \\"PackageCount\\": 0,\\n \\"MonthResolveCount\\": 9927326,\\n \\"AccountId\\": \\"1337****\\",\\n \\"UnsignedEnabled\\": true,\\n \\"UserStatus\\": 1,\\n \\"UnsignedCount\\": 1523,\\n \\"MonthHttpsResolveCount\\": 3,\\n \\"MonthFreeCount\\": 1500000,\\n \\"DohEnabled\\": true,\\n \\"DohResolveAllEnabled\\": true,\\n \\"MonthDohResolveCount\\": 10000,\\n \\"MonthHttpAesResolveCount\\": 0,\\n \\"MonthHttpsAesResolveCount\\": 0\\n }\\n}","type":"json"}]',
+ ],
+ 'GetResolveCountSummary' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -428,99 +314,72 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREemas5UUCVR',
- ],
+ 'abilityTreeNodes' => ['FEATUREemas5UUCVR'],
],
'parameters' => [
[
'name' => 'Granularity',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => 'day',
- 'required' => true,
- 'type' => 'string',
- ],
+ 'schema' => ['description' => 'The data granularity of the statistics. Valid values: **day** and **month**.', 'type' => 'string', 'required' => true, 'example' => 'day', 'title' => ''],
],
[
'name' => 'TimeSpan',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'example' => '7',
- 'format' => 'int32',
- 'required' => true,
- 'type' => 'integer',
- ],
+ 'schema' => ['description' => 'The time span for the statistics.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '7', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'description' => 'The request result.',
+ 'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'example' => '3106FFF3-3612-542A-B2CD-3CF4CD48****',
- 'type' => 'string',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3106FFF3-3612-542A-B2CD-3CF4CD48****', 'title' => ''],
'ResolveSummary' => [
- 'description' => '',
+ 'description' => 'The statistics result.',
+ 'type' => 'object',
'properties' => [
- 'Https6' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'Http6' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'Http' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'Https' => [
- 'description' => '',
- 'example' => '123',
- 'format' => 'int64',
- 'type' => 'integer',
- ],
- 'Doh' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'HttpAes' => [
- 'type' => 'string',
- ],
- 'HttpsAes' => [
- 'type' => 'string',
- ],
+ 'Https6' => ['description' => 'The number of IPv6 HTTPS resolution requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'Http6' => ['description' => 'The number of IPv6 HTTP resolution requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'Http' => ['description' => 'The number of IPv4 HTTP resolution requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'Https' => ['description' => 'The number of IPv4 HTTPS resolution requests.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''],
+ 'Doh' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'HttpAes' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'HttpsAes' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
- 'type' => 'object',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3106FFF3-3612-542A-B2CD-3CF4CD48****\\",\\n \\"ResolveSummary\\": {\\n \\"Https6\\": 123,\\n \\"Http6\\": 123,\\n \\"Http\\": 123,\\n \\"Https\\": 123,\\n \\"Doh\\": 0,\\n \\"HttpAes\\": \\"\\",\\n \\"HttpsAes\\": \\"\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetResolveCountSummaryResponse>\\n <RequestId>3106FFF3-3612-542A-B2CD-3CF4CD48A4A5</RequestId>\\n <ResolveSummary>\\n <Https6>123</Https6>\\n <Http6>123</Http6>\\n <Http>123</Http>\\n <Https>123</Https>\\n </ResolveSummary>\\n</GetResolveCountSummaryResponse>","errorExample":""}]',
- ],
- 'GetResolveStatistics' => [
- 'methods' => [
- 'post',
- 'get',
+ 'title' => 'Retrieve parse and billing statistics information',
+ 'summary' => 'Retrieves parse and billing statistics, corresponding to the "Billing" page feature in the console.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'httpdns:GetResolveCountSummary',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3106FFF3-3612-542A-B2CD-3CF4CD48****\\",\\n \\"ResolveSummary\\": {\\n \\"Https6\\": 123,\\n \\"Http6\\": 123,\\n \\"Http\\": 123,\\n \\"Https\\": 123,\\n \\"Doh\\": 0,\\n \\"HttpAes\\": \\"\\",\\n \\"HttpsAes\\": \\"\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetResolveStatistics' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -533,47 +392,22 @@
[
'name' => 'DomainName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'www.aliyun.com',
- ],
+ 'schema' => ['description' => 'The domain name for which you want to obtain statistics.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'www.aliyun.com', 'title' => ''],
],
[
'name' => 'Granularity',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'month',
- ],
+ 'schema' => ['description' => 'The data granularity. Valid values: **day** and **month**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'month', 'title' => ''],
],
[
'name' => 'TimeSpan',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2',
- ],
+ 'schema' => ['description' => 'The time span length.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''],
],
[
'name' => 'ProtocolName',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https',
- 'default' => 'http',
- ],
+ 'schema' => ['description' => 'The protocol type for DNS resolution. Valid values: http (default) and https.', 'type' => 'string', 'required' => false, 'default' => 'http', 'example' => 'https', 'title' => ''],
],
],
'responses' => [
@@ -581,57 +415,69 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50F9C40E-188D-B00B-BE2C-7427E531****',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50F9C40E-188D-B00B-BE2C-7427E531****', 'title' => ''],
'DataPoints' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DataPoint' => [
- 'description' => '',
+ 'description' => 'The data points.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Time' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1488297600',
- ],
- 'Count' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '9703',
- ],
+ 'Time' => ['description' => 'The resolution time.', 'type' => 'integer', 'format' => 'int32', 'example' => '1488297600', 'title' => ''],
+ 'Count' => ['description' => 'The number of requests.', 'type' => 'integer', 'format' => 'int32', 'example' => '9703', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"50F9C40E-188D-B00B-BE2C-7427E531****\\",\\n \\"DataPoints\\": {\\n \\"DataPoint\\": [\\n {\\n \\"Time\\": 1488297600,\\n \\"Count\\": 9703\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<GetResolveStatisticsResponse>\\n <RequestId>50F9C40E-1816-B00B-BE2C-7427E5316481</RequestId>\\n <DataPoints>\\n <DataPoint>\\n <Time>1488297600</Time>\\n <Count>9703</Count>\\n </DataPoint>\\n <DataPoint>\\n <Time>1490976000</Time>\\n <Count>9390</Count>\\n </DataPoint>\\n </DataPoints>\\n</GetResolveStatisticsResponse>","errorExample":""}]',
+ 'title' => 'GetResolveStatistics',
+ 'summary' => 'Obtains the statistics of DNS resolution requests for a specific domain name.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListDomains' => [
- 'summary' => '列举域名以及解析统计信息',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResolveStatistics'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'httpdns:GetResolveStatistics',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/{#DomainName}'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50F9C40E-188D-B00B-BE2C-7427E531****\\",\\n \\"DataPoints\\": {\\n \\"DataPoint\\": [\\n {\\n \\"Time\\": 1488297600,\\n \\"Count\\": 9703\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'ListDomains' => [
+ 'summary' => 'Lists the domain names and resolution counts of a user based on the specified parameters.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -643,51 +489,28 @@
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREemas5UUCVR',
- ],
+ 'abilityTreeNodes' => ['FEATUREemas5UUCVR'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '1',
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => 'The current page number. Minimum value: 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '500',
- 'minimum' => '1',
- 'example' => '20',
- 'default' => '20',
- ],
+ 'schema' => ['description' => 'The number of rows per page in a paged query. Maximum value: 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'minimum' => '1', 'default' => '20', 'example' => '20', 'title' => ''],
],
[
'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
[
'name' => 'WithoutMeteringData',
'in' => 'query',
- 'schema' => [
- 'type' => 'boolean',
- ],
+ 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -695,107 +518,83 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '50F9C40E-188D-4208-BE2C-7427E531****',
- ],
- 'PageNumber' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '18',
- ],
+ 'PageSize' => ['description' => 'The number of domain names returned in this query.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '50F9C40E-188D-4208-BE2C-7427E531****', 'title' => ''],
+ 'PageNumber' => ['description' => 'The total number of domain names in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of domain names in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''],
'DomainInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'DomainInfo' => [
- 'description' => '',
+ 'description' => 'The list of domain names returned in this query.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'ResolvedHttps6' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'Resolved' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'Resolved6' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '20',
- ],
- 'DomainName' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'www.example.com',
- ],
- 'ResolvedHttps' => [
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'TimeModified' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'ResolvedDoh' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'ResolveHttpAes' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
- 'ResolveHttpsAes' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'ResolvedHttps6' => ['description' => 'The number of HTTPS-IPv6 resolutions.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'Resolved' => ['description' => 'The number of HTTP-IPv4 resolutions.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'Resolved6' => ['description' => 'The number of HTTP-IPv6 resolutions.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
+ 'DomainName' => ['description' => 'The domain name.', 'type' => 'string', 'example' => 'www.example.com', 'title' => ''],
+ 'ResolvedHttps' => ['description' => 'The number of HTTPS-IPv4 resolutions.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
+ 'TimeModified' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'ResolvedDoh' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'ResolveHttpAes' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
+ 'ResolveHttpsAes' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"PageSize\\": 5,\\n \\"RequestId\\": \\"50F9C40E-188D-4208-BE2C-7427E531****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 18,\\n \\"DomainInfos\\": {\\n \\"DomainInfo\\": [\\n {\\n \\"ResolvedHttps6\\": 20,\\n \\"Resolved\\": 10,\\n \\"Resolved6\\": 20,\\n \\"DomainName\\": \\"www.example.com\\",\\n \\"ResolvedHttps\\": 10,\\n \\"TimeModified\\": 0,\\n \\"ResolvedDoh\\": 0,\\n \\"ResolveHttpAes\\": 0,\\n \\"ResolveHttpsAes\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\n<ListDomainsResponse>\\n <RequestId>50F9C40E-188D-4208-BE2C-7427E5316481</RequestId>\\n <TotalCount>18</TotalCount>\\n <PageNumber>1</PageNumber>\\n <PageSize>5</PageSize>\\n <DomainInfos>\\n <DomainInfo>\\n <DomainName>www.aliyun.com</DomainName>\\n <Resolved>10</Resolved>\\n <ResolvedHttps>20</ResolvedHttps>\\n </DomainInfo>\\n <DomainInfo>\\n <DomainName>bbs.aliyun.com</DomainName>\\n <Resolved>10</Resolved>\\n <ResolvedHttps>20</ResolvedHttps>\\n </DomainInfo>\\n <DomainInfo>\\n <DomainName>www.taobao.com</DomainName>\\n <Resolved>10</Resolved>\\n <ResolvedHttps>20</ResolvedHttps>\\n </DomainInfo>\\n <DomainInfo>\\n <DomainName>www.tmall.com</DomainName>\\n <Resolved>10</Resolved>\\n <ResolvedHttps>20</ResolvedHttps>\\n </DomainInfo>\\n <DomainInfo>\\n <DomainName>alipay.com</DomainName>\\n <Resolved>10</Resolved>\\n <ResolvedHttps>20</ResolvedHttps>\\n </DomainInfo>\\n </DomainInfos>\\n</ListDomainsResponse>","errorExample":""}]',
+ 'title' => 'Retrieve user domain names and resolution counts',
+ 'description' => '# Operation description'."\n"
+ ."\n"
+ .'- You can specify the page number (PageNumber) and the number of entries per page (PageSize) for the query.'."\n"
+ .'- By default, the domain name list is sorted by the time when domain names were added, from newest to oldest.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDomains'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'httpdns:ListDomains',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 5,\\n \\"RequestId\\": \\"50F9C40E-188D-4208-BE2C-7427E531****\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 18,\\n \\"DomainInfos\\": {\\n \\"DomainInfo\\": [\\n {\\n \\"ResolvedHttps6\\": 20,\\n \\"Resolved\\": 10,\\n \\"Resolved6\\": 20,\\n \\"DomainName\\": \\"www.example.com\\",\\n \\"ResolvedHttps\\": 10,\\n \\"TimeModified\\": 0,\\n \\"ResolvedDoh\\": 0,\\n \\"ResolveHttpAes\\": 0,\\n \\"ResolveHttpsAes\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'RefreshResolveCache' => [
- 'summary' => '刷新域名缓存',
+ 'summary' => 'Refreshes the domain name cache.',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -803,79 +602,197 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'Domains',
'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'The list of domain names to refresh.',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'www.aliyun.com',
- ],
+ 'items' => ['description' => 'The domain name.', 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com', 'title' => ''],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
+ 'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'FA8C2599-362D-4113-8FB4-E88A40C2****',
- ],
+ 'Code' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FA8C2599-362D-4113-8FB4-E88A40C2****', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'RamInsufficientPermission',
- 'errorMessage' => 'You are not authorized to do this operation.',
- ],
+ ['errorCode' => 'RamInsufficientPermission', 'errorMessage' => 'You are not authorized to do this operation.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'Refresh domain name resolution cache',
+ 'requestParamsDescription' => 'Refreshing wildcard domain names is not supported.',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'httpdns:RefreshResolveCache',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"FA8C2599-362D-4113-8FB4-E88A40C2****\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'httpdns.ap-southeast-1.aliyuncs.com',
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'httpdns.ap-southeast-1.aliyuncs.com', 'endpoint' => 'httpdns.ap-southeast-1.aliyuncs.com', 'vpc' => 'httpdns-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'httpdns-api.aliyuncs.com', 'endpoint' => 'httpdns-api.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'NoSuchVersion', 'message' => 'The specified version does not exist.', 'http_code' => null, 'description' => ''],
+ ['code' => 'RamInsufficientPermission', 'message' => 'You are not authorized to do this operation.', 'http_code' => 400, 'description' => ''],
+ ['code' => 'UserNotFound', 'message' => 'The user is not found.', 'http_code' => 400, 'description' => ''],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetResolveStatistics'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDomains'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'HTTPDNS',
+ 'productName' => 'Enterprise Mobile Application Studio',
+ 'ramCodes' => ['httpdns'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'GetResolveStatistics',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'httpdns:GetResolveStatistics',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/{#DomainName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DescribeDomains',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'httpdns:DescribeDomains',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RefreshResolveCache',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'httpdns:RefreshResolveCache',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDomain',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'httpdns:DeleteDomain',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/{#DomainName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddDomain',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'httpdns:AddDomain',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/{#DomainName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAccountInfo',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'httpdns:GetAccountInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetResolveCountSummary',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'httpdns:GetResolveCountSummary',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDomains',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'httpdns:ListDomains',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'HTTPDNS', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/*'],
+ ],
+ ],
+ ],
],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'httpdns-api.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/{#DomainName}'],
+ ['validationType' => 'always', 'resourceType' => 'Domain', 'arn' => 'acs:httpdns:*:{#accountId}:domain/*'],
],
],
];