diff --git a/en-US/actiontrail/CreateTrail.json b/en-US/actiontrail/CreateTrail.json index b8ddb1728..2867b1451 100644 --- a/en-US/actiontrail/CreateTrail.json +++ b/en-US/actiontrail/CreateTrail.json @@ -19,6 +19,20 @@ "type": "Boolean", "required": false }, + { + "name": "MaxComputeProjectArn", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "MaxComputeWriteRoleArn", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "Name", "description": "The name of the trail to be created.\n\nThe name must be 6 to 36 characters in length. The name must start with a lowercase letter and can contain lowercase letters, digits, hyphens (-), and underscores (\\_).\n\n> The name must be unique within your Alibaba Cloud account.", diff --git a/en-US/actiontrail/UpdateTrail.json b/en-US/actiontrail/UpdateTrail.json index 67b97bd3a..c44231151 100644 --- a/en-US/actiontrail/UpdateTrail.json +++ b/en-US/actiontrail/UpdateTrail.json @@ -12,6 +12,20 @@ "type": "String", "required": false }, + { + "name": "MaxComputeProjectArn", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "MaxComputeWriteRoleArn", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "Name", "description": "The name of the trail whose configurations you want to update.\n\nThe name must be 6 to 36 characters in length and can contain lowercase letters, digits, hyphens (-), and underscores (\\_). It must start with a lowercase letter.\n\n> The name must be unique within an Alibaba Cloud account.", diff --git a/en-US/adb/CreateElasticPlan.json b/en-US/adb/CreateElasticPlan.json index bc8573f8a..105a45287 100644 --- a/en-US/adb/CreateElasticPlan.json +++ b/en-US/adb/CreateElasticPlan.json @@ -26,6 +26,13 @@ "type": "String", "required": false }, + { + "name": "ElasticPlanMonthlyRepeat", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "ElasticPlanName", "description": "The name of the scaling plan.\n\n* The name must be 2 to 30 characters in length.\n* The name can contain letters, digits, and underscores (\\_).", diff --git a/en-US/adb/DescribeAuditLogRecords.json b/en-US/adb/DescribeAuditLogRecords.json index 4a32d5091..dddf8f497 100644 --- a/en-US/adb/DescribeAuditLogRecords.json +++ b/en-US/adb/DescribeAuditLogRecords.json @@ -24,7 +24,7 @@ "description": "The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.\n\n> - The end time must be later than the start time.\n> - The maximum time range that can be specified is 24 hours.", "position": "Query", "type": "String", - "required": true + "required": false }, { "name": "HostAddress", @@ -87,7 +87,7 @@ "description": "The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.\n\n> SQL audit logs can be queried only when SQL audit is enabled. Only SQL audit logs within the last 30 days can be queried. If SQL audit was disabled and re-enabled, only SQL audit logs from the time when SQL audit was re-enabled can be queried.", "position": "Query", "type": "String", - "required": true + "required": false }, { "name": "Succeed", diff --git a/en-US/adb/DescribeEIURange.json b/en-US/adb/DescribeEIURange.json index f6538b124..8ea0818c8 100644 --- a/en-US/adb/DescribeEIURange.json +++ b/en-US/adb/DescribeEIURange.json @@ -21,7 +21,7 @@ }, { "name": "DBClusterVersion", - "description": "", + "description": "The version of the AnalyticDB for MySQL Data Warehouse Edition cluster. Set the value to **3.0**.", "position": "Query", "type": "String", "required": false @@ -35,7 +35,7 @@ }, { "name": "RegionId", - "description": "", + "description": "The region ID of the cluster.\n\n> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.", "position": "Query", "type": "String", "required": true @@ -49,7 +49,7 @@ }, { "name": "ZoneId", - "description": "", + "description": "The zone ID of the cluster.\n\n> You can call the [DescribeRegions](~~612293~~) operation to query the most recent zone list.", "position": "Query", "type": "String", "required": false diff --git a/en-US/adb/ModifyElasticPlan.json b/en-US/adb/ModifyElasticPlan.json index 8a1fcb63e..646b2ddfb 100644 --- a/en-US/adb/ModifyElasticPlan.json +++ b/en-US/adb/ModifyElasticPlan.json @@ -26,6 +26,13 @@ "type": "String", "required": false }, + { + "name": "ElasticPlanMonthlyRepeat", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "ElasticPlanName", "description": "The name of the scaling plan.\n\n* The name must be 2 to 30 characters in length.\n* The name can contain letters, digits, and underscores (\\_).\n\n> You can call the [DescribeElasticPlan](~~190596~~) operation to query the information about all scaling plans of a cluster, including the scaling plan names.", diff --git a/en-US/adb/UntagResources.json b/en-US/adb/UntagResources.json index 9ca76037a..8fea7453c 100644 --- a/en-US/adb/UntagResources.json +++ b/en-US/adb/UntagResources.json @@ -7,35 +7,35 @@ "parameters": [ { "name": "All", - "description": "Specifies whether to detach all tags. This parameter takes effect only when the TagKey.N parameter is not specified. Valid values:\n\n* true\n* false\n\nDefault value: false.", + "description": "Specifies whether to remove all tags from clusters. Default value: false. Valid values:\n\n* **true**\n* **false**\n\n> If you specify TagKey and this parameter, this parameter does not take effect.", "position": "Query", "type": "Boolean", "required": false }, { "name": "RegionId", - "description": "The region ID of the instance. You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.", + "description": "The region ID.\n\n> You can call the [DescribeRegions](~~143074~~) operation to query the most recent region list.", "position": "Query", "type": "String", "required": true }, { "name": "ResourceId", - "description": "", + "description": "The ID of cluster N. Valid values of N: 1 to 50.", "position": "Query", "type": "RepeatList", "required": true }, { "name": "ResourceType", - "description": "The type of the cluster. Set the value to `ALIYUN::ADB::CLUSTER`.", + "description": "The resource type. Set the value to **ALIYUN::ADB::CLUSTER**.", "position": "Query", "type": "String", "required": true }, { "name": "TagKey", - "description": "", + "description": "The key of tag N. Valid values of N: 1 to 20.", "position": "Query", "type": "RepeatList", "required": false diff --git a/en-US/adb/version.json b/en-US/adb/version.json index b6900102b..8949d3794 100644 --- a/en-US/adb/version.json +++ b/en-US/adb/version.json @@ -264,7 +264,7 @@ }, "DescribeMaintenanceAction": { "title": "DescribeMaintenanceAction", - "summary": "Queries the information about an O\\\\\\&M event.", + "summary": "Queries the information about O\\&M events.", "deprecated": false }, "DescribeOperatorPermission": { @@ -484,7 +484,7 @@ }, "ModifyMaintenanceAction": { "title": "ModifyMaintenanceAction", - "summary": "Changes the switchover time of pending O\\\\\\&M events.", + "summary": "Changes the switchover time of O\\&M events.", "deprecated": false }, "ModifyResubmitConfig": { @@ -529,7 +529,7 @@ }, "UntagResources": { "title": "UntagResources", - "summary": "", + "summary": "Removes all tags from AnalyticDB for MySQL clusters.", "deprecated": false } } diff --git a/en-US/alb/CreateServerGroup.json b/en-US/alb/CreateServerGroup.json index 59d0c4e18..bdd201b6b 100644 --- a/en-US/alb/CreateServerGroup.json +++ b/en-US/alb/CreateServerGroup.json @@ -56,7 +56,7 @@ }, { "name": "ServerGroupType", - "description": "The type of server group. Valid values:\n\n* **Instance** (default): allows you to add servers by specifying **Ecs**, **Ens**, or **Eci**.\n* **Ip**: allows you to add servers by specifying IP addresses.\n* **Fc**: allows you to add servers by specifying functions of Function Compute.", + "description": "The type of server group. Valid values:\n\n* **Instance** (default): allows you to add servers by specifying **Ecs**, **Eni**, or **Eci**.\n* **Ip**: allows you to add servers by specifying IP addresses.\n* **Fc**: allows you to add servers by specifying functions of Function Compute.", "position": "Query", "type": "String", "required": false diff --git a/en-US/alb/ListServerGroups.json b/en-US/alb/ListServerGroups.json index e854f78d9..2adc6d34e 100644 --- a/en-US/alb/ListServerGroups.json +++ b/en-US/alb/ListServerGroups.json @@ -40,6 +40,13 @@ "type": "Array", "required": false }, + { + "name": "ServerGroupType", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "Tag", "description": "The tags that are added to the server group. You can specify up to 10 tags in each call.", diff --git a/en-US/alidns/AddCustomLine.json b/en-US/alidns/AddCustomLine.json index b0be9e804..d2d8d1c68 100644 --- a/en-US/alidns/AddCustomLine.json +++ b/en-US/alidns/AddCustomLine.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "DomainName", - "description": "The name of the custom line.", + "description": "The domain name.", "position": "Query", "type": "String", "required": true }, { "name": "IpSegment", - "description": "", + "description": "The CIDR blocks.", "position": "Query", "type": "RepeatList", "required": true, @@ -35,14 +35,14 @@ }, { "name": "Lang", - "description": "The domain name for which you configure the custom line.", + "description": "The language.", "position": "Query", "type": "String", "required": false }, { "name": "LineName", - "description": "The end IP address of the CIDR block.", + "description": "The name of the custom line.", "position": "Query", "type": "String", "required": true diff --git a/en-US/alidns/AddGtmMonitor.json b/en-US/alidns/AddGtmMonitor.json index c23dcca66..923821334 100644 --- a/en-US/alidns/AddGtmMonitor.json +++ b/en-US/alidns/AddGtmMonitor.json @@ -13,7 +13,7 @@ }, { "name": "EvaluationCount", - "description": "The maximum number of consecutive exceptions detected. If the number of consecutive exceptions detected reaches the maximum number, the application service is deemed abnormal.", + "description": "The number of consecutive failures.", "position": "Query", "type": "Integer", "required": true @@ -27,7 +27,7 @@ }, { "name": "IspCityNode", - "description": "The monitored nodes.", + "description": "The nodes for monitoring.", "position": "Query", "type": "RepeatList", "required": true, @@ -48,14 +48,14 @@ }, { "name": "Lang", - "description": "The language of the values of specific response parameters.", + "description": "The language.", "position": "Query", "type": "String", "required": false }, { "name": "MonitorExtendInfo", - "description": "The extended information, that is, the parameters required for the protocol. Different protocols require different parameters:\n\nHTTP or HTTPS:\n\n* port: the port to check.\n* failureRate: the failure rate.\n* code: the status code threshold. If the returned status code is greater than the specified threshold, the application service is deemed abnormal. Valid values: 400 and 500.\n* host: the host configuration.\n* path: the health check URL.\n\nPING:\n\n* packetNum: the number of ping packets.\n* packetLossRate: the loss rate of ping packets.\n* failureRate: the failure rate.\n\nTCP:\n\n* port: the port to check.\n* failureRate: the failure rate.", + "description": "The extended information. The required parameters vary based on the health check protocol.\n\nHTTP or HTTPS\n\n* port: the port that you want to check\n* failureRate: the failure rate\n* code: the return code. The health check result is deemed abnormal if the returned value is greater than the specified value. Valid values: 400 and 500.\n* host: the host settings\n* path: the URL path\n\nPING\n\n* packetNum: the number of ping packets\n* packetLossRate: the packet loss rate\n* failureRate: the failure rate\n\nTCP\n\n* port: the port that you want to check\n* failureRate: the failure rate", "position": "Query", "type": "String", "required": true diff --git a/en-US/alidns/DescribeBatchResultDetail.json b/en-US/alidns/DescribeBatchResultDetail.json index c6eb2411f..15c567128 100644 --- a/en-US/alidns/DescribeBatchResultDetail.json +++ b/en-US/alidns/DescribeBatchResultDetail.json @@ -7,42 +7,42 @@ "parameters": [ { "name": "BatchType", - "description": "The type of the batch operation. Valid values:\n\n* **DOMAIN_ADD**: adds domain names in batches.\n* **DOMAIN_DEL**: deletes domain names in batches.\n* **RR_ADD**: adds DNS records in batches.\n* **RR_DEL**: deletes DNS records in batches.", + "description": "The type of the batch operation. Valid values:\n\n* **DOMAIN_ADD**: adds domain names in batches.\n* **DOMAIN_DEL**: deletes domain names in batches.\n* **RR_ADD**: adds Domain Name System (DNS) records in batches.\n* **RR_DEL**: deletes DNS records in batches.", "position": "Query", "type": "String", "required": false }, { "name": "Lang", - "description": "The language type.", + "description": "The language.", "position": "Query", "type": "String", "required": false }, { "name": "PageNumber", - "description": "The number of the page to return. Default value: **1**.", + "description": "The page number. Default value: **1**.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "The number of entries to return on each page.", + "description": "The number of entries per page.", "position": "Query", "type": "Integer", "required": false }, { "name": "Status", - "description": "", + "description": "The execution result. If you do not specify this parameter, all results are returned.", "position": "Query", "type": "String", "required": false }, { "name": "TaskId", - "description": "The ID of the task.", + "description": "The ID of the batch operation task.", "position": "Query", "type": "Long", "required": false diff --git a/en-US/alidns/DescribeDnsGtmInstanceStatus.json b/en-US/alidns/DescribeDnsGtmInstanceStatus.json index 32cb81d50..ef6bc5349 100644 --- a/en-US/alidns/DescribeDnsGtmInstanceStatus.json +++ b/en-US/alidns/DescribeDnsGtmInstanceStatus.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "InstanceId", - "description": "The number of unavailable addresses.", + "description": "The ID of the instance.", "position": "Query", "type": "String", "required": true }, { "name": "Lang", - "description": "The ID of the instance.", + "description": "The language to return some response parameters. Default value: en. Valid values: en, zh, and ja.", "position": "Query", "type": "String", "required": false diff --git a/en-US/alidns/DescribeDnsProductInstances.json b/en-US/alidns/DescribeDnsProductInstances.json index 71c42bc0b..5bc4ebdc2 100644 --- a/en-US/alidns/DescribeDnsProductInstances.json +++ b/en-US/alidns/DescribeDnsProductInstances.json @@ -7,56 +7,56 @@ "parameters": [ { "name": "Direction", - "description": "", + "description": "The Sorting direction. Values:\n* **DESC**: Descending (if not specified, the default is descending order)\n* **ASC**: Ascending", "position": "Query", "type": "String", "required": false }, { "name": "DomainType", - "description": "", + "description": "The type of the domain name. Valid values:\n\n* PUBLIC (default): hosted public domain name\n* CACHE: cached public domain name", "position": "Query", "type": "String", "required": false }, { "name": "Lang", - "description": "The version code of the Alibaba Cloud DNS instance.", + "description": "The language of the content within the request and response. Valid values:\n\n* **zh** : Chinese\n* **en** (default) : English", "position": "Query", "type": "String", "required": false }, { "name": "OrderBy", - "description": "", + "description": "The Sorting parameter. Values:\n* createDate: Sort by creation time (if not specified, the default is to sort by creation time)\n* expireDate: Sort by expiration time", "position": "Query", "type": "String", "required": false }, { "name": "PageNumber", - "description": "The number of entries returned per page.", + "description": "The number of the page to return. Pages start from page **1**. Default value: **1**.", "position": "Query", "type": "Long", "required": false }, { "name": "PageSize", - "description": "The ID of the request.", + "description": "The number of entries to return on each page. Maximum value: **100**. Default value: **20**.", "position": "Query", "type": "Long", "required": false }, { "name": "UserClientIp", - "description": "The total number of domain names.", + "description": "The IP address of the client.", "position": "Query", "type": "String", "required": false }, { "name": "VersionCode", - "description": "The page number of the returned page.", + "description": "The version code of the Alibaba Cloud DNS instance.", "position": "Query", "type": "String", "required": false diff --git a/en-US/alidns/DescribeDomainStatistics.json b/en-US/alidns/DescribeDomainStatistics.json index dfabfb066..7cc7e4fae 100644 --- a/en-US/alidns/DescribeDomainStatistics.json +++ b/en-US/alidns/DescribeDomainStatistics.json @@ -9,7 +9,7 @@ "description": "The domain name.", "position": "Query", "type": "String", - "required": true + "required": false }, { "name": "DomainType", diff --git a/en-US/alidns/DescribeRecordStatisticsSummary.json b/en-US/alidns/DescribeRecordStatisticsSummary.json index 72c6a9445..db7e22e7b 100644 --- a/en-US/alidns/DescribeRecordStatisticsSummary.json +++ b/en-US/alidns/DescribeRecordStatisticsSummary.json @@ -13,14 +13,14 @@ }, { "name": "DomainType", - "description": "", + "description": "The type of the domain name. The parameter value is not case-sensitive. Valid values:\n\n* PUBLIC (default): hosted public domain name\n* CACHE: cache-accelerated domain name", "position": "Query", "type": "String", "required": false }, { "name": "EndDate", - "description": "The end of the time range to query. Specify the time in the **YYYY-MM-DD** format.\n\nThe default value is the day when you perform the operation.", + "description": "The end date of the query. Specify the start date in the **YYYY-MM-DD** format.\n\nThe default value is the day when you query the data.", "position": "Query", "type": "String", "required": false @@ -34,42 +34,42 @@ }, { "name": "Lang", - "description": "The language type.", + "description": "The language.", "position": "Query", "type": "String", "required": false }, { "name": "PageNumber", - "description": "The number of the page to return. Pages start from page **1**. Default value: **1**.", + "description": "The page number. Pages start from page **1**. Default value: **1**.", "position": "Query", "type": "Long", "required": false }, { "name": "PageSize", - "description": "The number of entries to return on each page. Maximum value: **100**. Minimum value: **1**. Default value: **20**.", + "description": "The number of entries per page. Valid values: **1 to 100**. Default value: **20**.", "position": "Query", "type": "Long", "required": false }, { "name": "SearchMode", - "description": "The search mode of the keyword. Valid values:\n\n* **LIKE**: fuzzy match (default).\n* **EXACT**: exact match.", + "description": "The search mode of the keyword. Valid values:\n\n* **LIKE** (default): fuzzy search\n* **EXACT**: exact search", "position": "Query", "type": "String", "required": false }, { "name": "StartDate", - "description": "The beginning of the time range to query. Specify the time in the **YYYY-MM-DD** format.\n\nYou can only query DNS records of the last 90 days.", + "description": "The start date of the query. Specify the start date in the **YYYY-MM-DD** format.\n\nYou can only query the DNS records within the last 90 days.``", "position": "Query", "type": "String", "required": true }, { "name": "Threshold", - "description": "The threshold of query volume that can be obtained. You can also obtain data about a domain name with the query volume less than or equal to the threshold. For example, if you set this parameter to 100, you can query domain names with less than 100 queries.", + "description": "The maximum number of DNS requests that you can obtain. You can obtain data about a domain name with DNS request volume less than or equal to the maximum number. For example, if you set this parameter to 100, you can query domain names with less than 100 DNS requests.", "position": "Query", "type": "Long", "required": false diff --git a/en-US/alidns/SetDNSSLBStatus.json b/en-US/alidns/SetDNSSLBStatus.json index 47776f8d9..2ddebca6f 100644 --- a/en-US/alidns/SetDNSSLBStatus.json +++ b/en-US/alidns/SetDNSSLBStatus.json @@ -14,42 +14,42 @@ }, { "name": "Lang", - "description": "The language of the subdomain.", + "description": "The language.", "position": "Query", "type": "String", "required": false }, { "name": "Line", - "description": "", + "description": "The DNS resolution line. The line can be the default line, China Telecom, and China Mobile.", "position": "Query", "type": "String", "required": false }, { "name": "Open", - "description": "Specifies whether to enable or disable weighted round-robin. Valid values:\n\n* **true**: enables weighted round-robin. This is the default value.\n* **false**: disables weighted round-robin.", + "description": "Specifies whether to enable or disable weighted round-robin. Valid values:\n\n* **true** (default): enables weighted round-robin.\n* **false**: disables weighted round-robin.", "position": "Query", "type": "Boolean", "required": false }, { "name": "SubDomain", - "description": "The subdomain for which you want to configure weighted round-robin. Do not set the value to a string such as aliyun.com. Instead, set the value to @.aliyun.com.", + "description": "The subdomain name for which you want to enable weighted round-robin. Set the parameter to @.example.com instead of example.com.", "position": "Query", "type": "String", "required": true }, { "name": "Type", - "description": "The type of the DNS record. Valid values: A and AAAA. Default value: A.", + "description": "The type of the Domain Name System (DNS) record. Valid values: A and AAAA. Default value: A.", "position": "Query", "type": "String", "required": false }, { "name": "UserClientIp", - "description": "The IP address of the client that you use to configure weighted round-robin.", + "description": "The IP address of the client.", "position": "Query", "type": "String", "required": false diff --git a/en-US/alidns/TransferDomain.json b/en-US/alidns/TransferDomain.json index cb1354207..fda07fa6f 100644 --- a/en-US/alidns/TransferDomain.json +++ b/en-US/alidns/TransferDomain.json @@ -6,28 +6,28 @@ "parameters": [ { "name": "DomainNames", - "description": "The list of domain names. Separate multiple domain names with commas (,). Only domain names registered with Alibaba Cloud are supported.", + "description": "The domain names. Separate multiple domain names with commas (,). Only domain names registered with Alibaba Cloud are supported.", "position": "Query", "type": "String", "required": true }, { "name": "Lang", - "description": "The language type.", + "description": "The language of the content within the request and response. Default value: **zh**. Valid values:\n\n* **zh**: Chinese\n* **en**: English", "position": "Query", "type": "String", "required": false }, { "name": "Remark", - "description": "The detailed information.", + "description": "The description of the domain name.", "position": "Query", "type": "String", "required": false }, { "name": "TargetUserId", - "description": "The ID of the user to which domain names were transferred.", + "description": "The destination user ID. The domain names and their Domain Name System (DNS) records are transferred to the destination user ID.", "position": "Query", "type": "Long", "required": true diff --git a/en-US/alidns/UntagResources.json b/en-US/alidns/UntagResources.json index 99254af13..c9ae63f57 100644 --- a/en-US/alidns/UntagResources.json +++ b/en-US/alidns/UntagResources.json @@ -7,35 +7,35 @@ "parameters": [ { "name": "All", - "description": "", + "description": "Specifies whether to remove all tags. Default value: false. This parameter is valid only when TagKey is left empty. Valid values: true and false.", "position": "Query", "type": "Boolean", "required": false }, { "name": "Lang", - "description": "", + "description": "The language.", "position": "Query", "type": "String", "required": false }, { "name": "ResourceId", - "description": "The language in which you want the values of some response parameters to be returned. These response parameters support multiple languages.", + "description": "The resource ID.", "position": "Query", "type": "RepeatList", "required": true }, { "name": "ResourceType", - "description": "Resource Type", + "description": "The resource type.", "position": "Query", "type": "String", "required": true }, { "name": "TagKey", - "description": "Specifies whether to remove all tags from the specified resource. Default value: false. This parameter takes effect only when the TagKey.N parameter is not specified. Valid values:\n\n* true\n* false", + "description": "The tags added to the resource.", "position": "Query", "type": "RepeatList", "required": false diff --git a/en-US/alidns/version.json b/en-US/alidns/version.json index dcf82abe9..d4c289984 100644 --- a/en-US/alidns/version.json +++ b/en-US/alidns/version.json @@ -13,8 +13,8 @@ "deprecated": false }, "AddDnsGtmAccessStrategy": { - "title": "AddDnsGtmAccessStrategy (new)", - "summary": "Creates an access policy for a Global Traffic Manager (GTM) instance.", + "title": "AddDnsGtmAccessStrategy", + "summary": "Creates an access policy.", "deprecated": false }, "AddDnsGtmAddressPool": { @@ -124,7 +124,7 @@ }, "DeleteDomainGroup": { "title": "DeleteDomainGroup", - "summary": "Deletes a domain name group.", + "summary": "Deletes a domain name group. After you delete the domain name group, the domain names in the group are moved to the default group.", "deprecated": false }, "DeleteDomainRecord": { @@ -264,11 +264,11 @@ }, "DescribeDnsProductInstances": { "title": "DescribeDnsProductInstances", - "summary": "Queries paid Alibaba Cloud DNS instances based on the specified parameters.", + "summary": "Calls the DescribeDnsProductInstances operation to query the list of paid Alibaba Cloud DNS instances based on input parameters.", "deprecated": false }, "DescribeDohAccountStatistics": { - "title": "", + "title": "DescribeDohAccountStatistics", "summary": "", "deprecated": false }, @@ -364,7 +364,7 @@ }, "DescribeGtmAccessStrategyAvailableConfig": { "title": "DescribeGtmAccessStrategyAvailableConfig", - "summary": "You can call this operation to query the available configurations of the current access policy of a Global Traffic Manager (GTM) policy.", + "summary": "Queries the configuration items that can be set for an access policy.", "deprecated": false }, "DescribeGtmAvailableAlertGroup": { @@ -588,8 +588,8 @@ "deprecated": false }, "OperateBatchDomain": { - "title": "Managing domain names and DNS records in batches", - "summary": "Calls the OperateBatchDomain operation to submit a task for adding or deleting domain names or DNS records in batches.", + "title": "OperateBatchDomain", + "summary": "Submits a batch operation task to add or delete multiple domain names or multiple Domain Name System (DNS) records at a time.", "deprecated": false }, "PausePdnsService": { @@ -638,8 +638,8 @@ "deprecated": false }, "SetDnsGtmMonitorStatus": { - "title": "SetDnsGtmMonitorStatus (new)", - "summary": "Sets the status of the health check feature for an address pool of a Global Traffic Manager (GTM) instance.", + "title": "SetDnsGtmMonitorStatus", + "summary": "Specifies the health check status of an address pool.", "deprecated": false }, "SetDomainDnssecStatus": { @@ -704,7 +704,7 @@ }, "UpdateDNSSLBWeight": { "title": "UpdateDNSSLBWeight", - "summary": "Changes the weight of a DNS record.", + "summary": "Modifies the weight of a Domain Name System (DNS) record based on the specified parameters.", "deprecated": false }, "UpdateDnsCacheDomain": { @@ -718,8 +718,8 @@ "deprecated": false }, "UpdateDnsGtmAccessStrategy": { - "title": "UpdateDnsGtmAccessStrategy (new)", - "summary": "Modifies an access policy of a Global Traffic Manager (GTM) instance.", + "title": "UpdateDnsGtmAccessStrategy", + "summary": "Modifies an access policy.", "deprecated": false }, "UpdateDnsGtmAddressPool": { diff --git a/en-US/alikafka/QueryMessage.json b/en-US/alikafka/QueryMessage.json new file mode 100644 index 000000000..467891be9 --- /dev/null +++ b/en-US/alikafka/QueryMessage.json @@ -0,0 +1,58 @@ +{ + "name": "QueryMessage", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET", + "pathPattern": "", + "parameters": [ + { + "name": "BeginTime", + "description": "", + "position": "Query", + "type": "Long", + "required": false + }, + { + "name": "InstanceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "Offset", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Partition", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "QueryType", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "RegionId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "Topic", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/alikafka/UpdateTopicConfig.json b/en-US/alikafka/UpdateTopicConfig.json new file mode 100644 index 000000000..7484d42ef --- /dev/null +++ b/en-US/alikafka/UpdateTopicConfig.json @@ -0,0 +1,44 @@ +{ + "name": "UpdateTopicConfig", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "Config", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "InstanceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "RegionId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "Topic", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "Value", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/alikafka/version.json b/en-US/alikafka/version.json index 10a40f95b..606ddccf7 100644 --- a/en-US/alikafka/version.json +++ b/en-US/alikafka/version.json @@ -137,6 +137,11 @@ "summary": "Modifies the description of a specified topic.", "deprecated": false }, + "QueryMessage": { + "title": null, + "summary": null, + "deprecated": false + }, "ReleaseInstance": { "title": "ReleaseInstance", "summary": "Releases a pay-as-you-go Message Queue for Apache Kafka instance.", @@ -172,6 +177,11 @@ "summary": "Updates the configurations of an instance.", "deprecated": false }, + "UpdateTopicConfig": { + "title": null, + "summary": null, + "deprecated": false + }, "UpgradeInstanceVersion": { "title": "UpgradeInstanceVersion", "summary": "Updates the version of an instance.", diff --git a/en-US/arms/AddIntegration.json b/en-US/arms/AddIntegration.json index 8ff9134e1..31e412e83 100644 --- a/en-US/arms/AddIntegration.json +++ b/en-US/arms/AddIntegration.json @@ -1,6 +1,6 @@ { "name": "AddIntegration", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "GET|POST", "pathPattern": "", diff --git a/en-US/arms/AddTagToFlinkCluster.json b/en-US/arms/AddTagToFlinkCluster.json new file mode 100644 index 000000000..461562cfc --- /dev/null +++ b/en-US/arms/AddTagToFlinkCluster.json @@ -0,0 +1,51 @@ +{ + "name": "AddTagToFlinkCluster", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "ClusterId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "FlinkWorkSpaceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "FlinkWorkSpaceName", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "RegionId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "ResourceGroupId", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "TargetUserId", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/arms/CheckCommercialStatus.json b/en-US/arms/CheckCommercialStatus.json index 3a393d04c..9801de826 100644 --- a/en-US/arms/CheckCommercialStatus.json +++ b/en-US/arms/CheckCommercialStatus.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "RegionId", - "description": "", + "description": "The region ID. Default value: cn-hangzhou.", "position": "Query", "type": "String", "required": false }, { "name": "Service", - "description": "", + "description": "Sub-services:\n- apm: Application Monitoring\n- rum: Real User Monitoring\n- prometheus: Managed Service for Prometheus\n- xtrace: Managed Service for OpenTelemetry", "position": "Query", "type": "String", "required": false diff --git a/en-US/arms/CreateEnvironment.json b/en-US/arms/CreateEnvironment.json index 54e080934..7b866969c 100644 --- a/en-US/arms/CreateEnvironment.json +++ b/en-US/arms/CreateEnvironment.json @@ -14,7 +14,7 @@ }, { "name": "BindResourceId", - "description": "The ID of the resource associated with the environment, such as the ACK cluster ID or VPC ID.", + "description": "The ID of the resource bound to the environment, such as the container ID or VPC ID. For a Cloud environment, specify the region ID.", "position": "Query", "type": "String", "required": true @@ -28,7 +28,7 @@ }, { "name": "EnvironmentSubType", - "description": "The subtype of the environment. Valid values:\n\n* CS: Container Service for Kubernetes (ACK)\n* ECS: ECS\n* Cloud: cloud service", + "description": "The subtype of the environment. Valid values:\n\n* CS: Container Service for Kubernetes (ACK)\n* ECS: Elastic Compute Service (ECS)\n* Cloud: cloud service", "position": "Query", "type": "String", "required": true @@ -40,6 +40,13 @@ "type": "String", "required": true }, + { + "name": "ManagedType", + "description": "type of managed: \n- none: not managed. default value of prometheus for ACK.\n- agent: managed agent. default value of promehtues for ASK/ACS/AckOne.\n- agent-exproter: maanged agent and exporter. default of prometheus for Cloud.", + "position": "Query", + "type": "String", + "required": false + }, { "name": "RegionId", "description": "The region ID.", @@ -56,7 +63,7 @@ }, { "name": "Tags", - "description": "The tags to add to the instance.", + "description": "The tags of the instance. You can specify this parameter to manage tags for the instance.", "position": "Query", "type": "RepeatList", "required": false, diff --git a/en-US/arms/CreateGrafanaWorkspace.json b/en-US/arms/CreateGrafanaWorkspace.json new file mode 100644 index 000000000..030d1f23b --- /dev/null +++ b/en-US/arms/CreateGrafanaWorkspace.json @@ -0,0 +1,86 @@ +{ + "name": "CreateGrafanaWorkspace", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "POST", + "pathPattern": "", + "parameters": [ + { + "name": "AliyunLang", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Description", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "GrafanaVersion", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "GrafanaWorkspaceEdition", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "GrafanaWorkspaceName", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "Password", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "RegionId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "ResourceGroupId", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Tags", + "description": "", + "position": "Query", + "type": "Json", + "required": false, + "sub_parameters": [ + { + "name": "Key", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Value", + "position": "Query", + "type": "String", + "required": false + } + ] + } + ] +} \ No newline at end of file diff --git a/en-US/arms/CreatePrometheusInstance.json b/en-US/arms/CreatePrometheusInstance.json index 4a6686c52..6e8eef12a 100644 --- a/en-US/arms/CreatePrometheusInstance.json +++ b/en-US/arms/CreatePrometheusInstance.json @@ -28,7 +28,7 @@ }, { "name": "ClusterType", - "description": "Types include:\n- remote-write: General-purpose Instance\n- ecs: Prometheus for ECS\n- global-view: Global Aggregation Instance\n- aliyun-cs: Prometheus Instance for Container Service", + "description": "Types include:\n- remote-write: General-purpose Instance\n- ecs: Prometheus for ECS\n- global-view: Global Aggregation Instance\n- aliyun-cs: Prometheus Instance for Container Service\n- cloud-product: Prometheus for cloud monitor\n- cloud-monitor: Prometheus for enterprise cloud monitor\n- flink: Prometheus for Flink", "position": "Query", "type": "String", "required": true diff --git a/en-US/arms/DeleteGrafanaWorkspace.json b/en-US/arms/DeleteGrafanaWorkspace.json new file mode 100644 index 000000000..c0bf30dbf --- /dev/null +++ b/en-US/arms/DeleteGrafanaWorkspace.json @@ -0,0 +1,23 @@ +{ + "name": "DeleteGrafanaWorkspace", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "POST", + "pathPattern": "", + "parameters": [ + { + "name": "GrafanaWorkspaceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "RegionId", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/arms/DeleteIntegration.json b/en-US/arms/DeleteIntegration.json index a9e71d649..6c5baa4c6 100644 --- a/en-US/arms/DeleteIntegration.json +++ b/en-US/arms/DeleteIntegration.json @@ -1,6 +1,6 @@ { "name": "DeleteIntegration", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "GET|POST", "pathPattern": "", diff --git a/en-US/arms/GetGrafanaWorkspace.json b/en-US/arms/GetGrafanaWorkspace.json new file mode 100644 index 000000000..1c4f22694 --- /dev/null +++ b/en-US/arms/GetGrafanaWorkspace.json @@ -0,0 +1,30 @@ +{ + "name": "GetGrafanaWorkspace", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "AliyunLang", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "GrafanaWorkspaceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "RegionId", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/arms/GetIntegrationState.json b/en-US/arms/GetIntegrationState.json index d350b72eb..1cc3796f9 100644 --- a/en-US/arms/GetIntegrationState.json +++ b/en-US/arms/GetIntegrationState.json @@ -1,6 +1,6 @@ { "name": "GetIntegrationState", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "GET|POST", "pathPattern": "", diff --git a/en-US/arms/GetSyntheticMonitors.json b/en-US/arms/GetSyntheticMonitors.json index 6ed3e0055..978a4d58c 100644 --- a/en-US/arms/GetSyntheticMonitors.json +++ b/en-US/arms/GetSyntheticMonitors.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "Filter", - "description": "", + "description": "The query conditions.", "position": "Query", "type": "String", "required": true }, { "name": "RegionId", - "description": "", + "description": "The region ID.", "position": "Query", "type": "String", "required": false diff --git a/en-US/arms/GetTimingSyntheticTask.json b/en-US/arms/GetTimingSyntheticTask.json index a40e91ce1..41d5d39d8 100644 --- a/en-US/arms/GetTimingSyntheticTask.json +++ b/en-US/arms/GetTimingSyntheticTask.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "RegionId", - "description": "", + "description": "The region ID.", "position": "Query", "type": "String", "required": false }, { "name": "TaskId", - "description": "", + "description": "The ID of the synthetic monitoring task.", "position": "Query", "type": "String", "required": false diff --git a/en-US/arms/InitEnvironment.json b/en-US/arms/InitEnvironment.json index 6871c80a9..f2a0342b5 100644 --- a/en-US/arms/InitEnvironment.json +++ b/en-US/arms/InitEnvironment.json @@ -7,18 +7,25 @@ "parameters": [ { "name": "AliyunLang", - "description": "Locale, the default is Chinese zh.", + "description": "The language. Valid values: zh and en. Default value: zh.", "position": "Query", "type": "String", "required": false }, { "name": "EnvironmentId", - "description": "Environment ID.", + "description": "The ID of the environment instance.", "position": "Query", "type": "String", "required": true }, + { + "name": "ManagedType", + "description": "type of managed:\n- none: not managed. default value of prometheus for ACK.\n- agent: managed agent. default value of promehtues for ASK/ACS/AckOne.\n- agent-exproter: maanged agent and exporter. default of prometheus for Cloud.", + "position": "Query", + "type": "String", + "required": false + }, { "name": "RegionId", "description": "The region ID.", diff --git a/en-US/arms/InstallManagedPrometheus.json b/en-US/arms/InstallManagedPrometheus.json index ce23b37cb..79a33643d 100644 --- a/en-US/arms/InstallManagedPrometheus.json +++ b/en-US/arms/InstallManagedPrometheus.json @@ -21,7 +21,7 @@ }, { "name": "ClusterType", - "description": "The type of the monitoring object. Valid values: ask and ecs.", + "description": "The cluster type.\n\nValid values:\n\n* ecs\n\n \n\n \n\n \n\n* one\n\n \n\n \n\n \n\n* ask\n\n \n\n \n\n \n\n* pro\n\n \n\n \n\n ", "position": "Query", "type": "String", "required": true diff --git a/en-US/arms/ListEnvironmentDashboards.json b/en-US/arms/ListEnvironmentDashboards.json new file mode 100644 index 000000000..a46f8701b --- /dev/null +++ b/en-US/arms/ListEnvironmentDashboards.json @@ -0,0 +1,37 @@ +{ + "name": "ListEnvironmentDashboards", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "AddonName", + "description": "Name of Addon.AddonName and Scene are required.", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnvironmentId", + "description": "The ID of the environment instance.", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "RegionId", + "description": "The ID of the region.", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Scene", + "description": "Scene of Addon.AddonName and Scene are required", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/arms/ListEnvironments.json b/en-US/arms/ListEnvironments.json index a2b5569ec..e8fd7158b 100644 --- a/en-US/arms/ListEnvironments.json +++ b/en-US/arms/ListEnvironments.json @@ -12,6 +12,13 @@ "type": "String", "required": false }, + { + "name": "BindResourceId", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "EnvironmentType", "description": "Environment type, AddonName or EnvironmentType must be at least one.", diff --git a/en-US/arms/ListGrafanaWorkspace.json b/en-US/arms/ListGrafanaWorkspace.json index e50ab9092..264837065 100644 --- a/en-US/arms/ListGrafanaWorkspace.json +++ b/en-US/arms/ListGrafanaWorkspace.json @@ -2,7 +2,7 @@ "name": "ListGrafanaWorkspace", "deprecated": false, "protocol": "HTTP|HTTPS", - "method": "POST", + "method": "GET|POST", "pathPattern": "", "parameters": [ { diff --git a/en-US/arms/ListTimingSyntheticTasks.json b/en-US/arms/ListTimingSyntheticTasks.json index 8fba5a9d5..68f53056e 100644 --- a/en-US/arms/ListTimingSyntheticTasks.json +++ b/en-US/arms/ListTimingSyntheticTasks.json @@ -7,28 +7,28 @@ "parameters": [ { "name": "RegionId", - "description": "", + "description": "The region ID.", "position": "Query", "type": "String", "required": false }, { "name": "ResourceGroupId", - "description": "", + "description": "The ID of the resource group.", "position": "Query", "type": "String", "required": false }, { "name": "Search", - "description": "", + "description": "The search keyword.", "position": "Query", "type": "String", "required": false }, { "name": "Tags", - "description": "", + "description": "The tags.", "position": "Query", "type": "Json", "required": false, diff --git a/en-US/arms/ListTraceApps.json b/en-US/arms/ListTraceApps.json index 734672c7c..f2e077ab7 100644 --- a/en-US/arms/ListTraceApps.json +++ b/en-US/arms/ListTraceApps.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "AppType", - "description": "", + "description": "The type of the application that is associated with the alert rule. Valid values:\n\n* `TRACE`: Application Monitoring\n* `EBPF`: Application Monitoring eBPF Edition", "position": "Query", "type": "String", "required": false diff --git a/en-US/arms/UpdateGrafanaWorkspace.json b/en-US/arms/UpdateGrafanaWorkspace.json new file mode 100644 index 000000000..a7dc7759f --- /dev/null +++ b/en-US/arms/UpdateGrafanaWorkspace.json @@ -0,0 +1,44 @@ +{ + "name": "UpdateGrafanaWorkspace", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "POST", + "pathPattern": "", + "parameters": [ + { + "name": "AliyunLang", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Description", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "GrafanaWorkspaceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "GrafanaWorkspaceName", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "RegionId", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/arms/UpdateGrafanaWorkspaceVersion.json b/en-US/arms/UpdateGrafanaWorkspaceVersion.json new file mode 100644 index 000000000..1c7cee74d --- /dev/null +++ b/en-US/arms/UpdateGrafanaWorkspaceVersion.json @@ -0,0 +1,37 @@ +{ + "name": "UpdateGrafanaWorkspaceVersion", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "POST", + "pathPattern": "", + "parameters": [ + { + "name": "AliyunLang", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "GrafanaVersion", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "GrafanaWorkspaceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "RegionId", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/arms/UpdateTimingSyntheticTask.json b/en-US/arms/UpdateTimingSyntheticTask.json index cc2b99570..2f7fb2446 100644 --- a/en-US/arms/UpdateTimingSyntheticTask.json +++ b/en-US/arms/UpdateTimingSyntheticTask.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "AvailableAssertions", - "description": "", + "description": "The list of assertions.", "position": "Query", "type": "Json", "required": false, @@ -40,42 +40,35 @@ }, { "name": "CommonSetting", - "description": "", + "description": "The general settings.", "position": "Query", "type": "String", "required": false }, { "name": "CustomPeriod", - "description": "", + "description": "The custom cycle.", "position": "Query", "type": "String", "required": false }, { "name": "Frequency", - "description": "", + "description": "The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.", "position": "Query", "type": "String", "required": false }, - { - "name": "MonitorCategory", - "description": "", - "position": "Query", - "type": "Integer", - "required": false - }, { "name": "MonitorConf", - "description": "", + "description": "The monitoring configurations.", "position": "Query", "type": "String", "required": false }, { "name": "Monitors", - "description": "", + "description": "The list of monitoring points.", "position": "Query", "type": "Json", "required": false, @@ -102,28 +95,28 @@ }, { "name": "Name", - "description": "", + "description": "The name of the task.", "position": "Query", "type": "String", "required": false }, { "name": "RegionId", - "description": "", + "description": "The region ID.", "position": "Query", "type": "String", "required": false }, { "name": "ResourceGroupId", - "description": "", + "description": "The resource group ID.", "position": "Query", "type": "String", "required": false }, { "name": "Tags", - "description": "", + "description": "The list of tags.", "position": "Query", "type": "Json", "required": false, @@ -144,17 +137,10 @@ }, { "name": "TaskId", - "description": "", + "description": "The ID of the synthetic monitoring task.", "position": "Query", "type": "String", "required": false - }, - { - "name": "TaskType", - "description": "", - "position": "Query", - "type": "Integer", - "required": false } ] } \ No newline at end of file diff --git a/en-US/arms/version.json b/en-US/arms/version.json index 3883f8275..8c65bf4fb 100644 --- a/en-US/arms/version.json +++ b/en-US/arms/version.json @@ -15,7 +15,7 @@ "AddIntegration": { "title": "AddIntegration", "summary": "Integrates the dashboard and collection rules of Managed Service for Prometheus.", - "deprecated": false + "deprecated": true }, "AddPrometheusGlobalView": { "title": "AddPrometheusGlobalView", @@ -47,6 +47,11 @@ "summary": "Creates or updates a recording rule of Managed Service for Prometheus.", "deprecated": false }, + "AddTagToFlinkCluster": { + "title": "AddTagToFlinkCluster", + "summary": "Associates a Prometheus instance with the ID and name of a Flink workspace.", + "deprecated": false + }, "AppendInstancesToPrometheusGlobalView": { "title": "AppendInstancesToPrometheusGlobalView", "summary": "Adds a data source to a global aggregation instance.", @@ -137,6 +142,11 @@ "summary": "Creates an environment instance.", "deprecated": false }, + "CreateGrafanaWorkspace": { + "title": null, + "summary": null, + "deprecated": false + }, "CreateIntegration": { "title": "CreateIntegration", "summary": "Creates an alert integration.", @@ -307,6 +317,11 @@ "summary": "Deletes Grafana dashboard resources from a Prometheus instance.", "deprecated": false }, + "DeleteGrafanaWorkspace": { + "title": null, + "summary": null, + "deprecated": false + }, "DeleteIMRobot": { "title": "DeleteIMRobot", "summary": "Deletes an instant messaging (IM) chatbot.", @@ -315,7 +330,7 @@ "DeleteIntegration": { "title": "DeleteIntegration", "summary": "Deletes collection rules from an integration.", - "deprecated": false + "deprecated": true }, "DeleteIntegrations": { "title": "DeleteIntegrations", @@ -354,7 +369,7 @@ }, "DeleteRetcodeApp": { "title": "DeleteRetcodeApp", - "summary": "Deletes a browser monitoring task.", + "summary": "Deletes a Browser Monitoring task.", "deprecated": false }, "DeleteScenario": { @@ -507,10 +522,15 @@ "summary": "Enables the Explore feature of Grafana.", "deprecated": false }, + "GetGrafanaWorkspace": { + "title": null, + "summary": null, + "deprecated": false + }, "GetIntegrationState": { "title": "GetIntegrationState", "summary": "Queries the status of an integration.", - "deprecated": false + "deprecated": true }, "GetManagedPrometheusStatus": { "title": "GetManagedPrometheusStatus", @@ -569,7 +589,7 @@ }, "GetRetcodeDataByQuery": { "title": "GetRetcodeDataByQuery", - "summary": "Queries the Browser Monitoring data based on a query statement of Log Service.", + "summary": "Queries Browser Monitoring data based on a query statement of Simple Log Service.", "deprecated": false }, "GetRetcodeLogstore": { @@ -584,7 +604,7 @@ }, "GetSourceMapInfo": { "title": "GetSourceMapInfo", - "summary": "Obtains the details of the SourceMap file uploaded in Browser Monitoring.", + "summary": "Obtains the details of the SourceMap files uploaded in Browser Monitoring.", "deprecated": false }, "GetStack": { @@ -593,8 +613,8 @@ "deprecated": false }, "GetSyntheticMonitors": { - "title": null, - "summary": null, + "title": "GetSyntheticMonitors", + "summary": "", "deprecated": false }, "GetSyntheticTaskDetail": { @@ -717,6 +737,11 @@ "summary": "Queries the ServiceMonitors of an environment.", "deprecated": false }, + "ListEnvironmentDashboards": { + "title": "ListEnvironmentDashboards", + "summary": "Query the dashboards list in the environment.", + "deprecated": false + }, "ListEnvironmentFeatures": { "title": "ListEnvironmentFeatures", "summary": "Queries the features installed in an environment.", @@ -934,7 +959,7 @@ }, "SearchRetcodeAppByPage": { "title": "SearchRetcodeAppByPage", - "summary": "Queries Browser Monitoring tasks by page.", + "summary": "Queries browser monitoring tasks by page.", "deprecated": false }, "SearchTraceAppByName": { @@ -964,7 +989,7 @@ }, "SetRetcodeShareStatus": { "title": "SetRetcodeShareStatus", - "summary": "Turns on or turns off logon-free sharing for an application monitored by Browser Monitoring.", + "summary": "Turns on or turns off logon-free sharing for an application monitored by Browser Monitoring. If you turn on logon-free sharing, you can call the GetRetcodeShareUrl operation to obtain a logon-free URL and then visit Browser Monitoring pages by using the URL.", "deprecated": false }, "StartAlert": { @@ -1057,14 +1082,24 @@ "summary": "Updates the configuration of an environment.", "deprecated": false }, + "UpdateGrafanaWorkspace": { + "title": null, + "summary": null, + "deprecated": false + }, + "UpdateGrafanaWorkspaceVersion": { + "title": null, + "summary": null, + "deprecated": false + }, "UpdateIntegration": { "title": "UpdateIntegration", "summary": "Modifies an alert integration.", "deprecated": false }, "UpdateMetricDrop": { - "title": null, - "summary": null, + "title": "UpdateMetricDrop", + "summary": "Updates the list of discarded metrics.", "deprecated": false }, "UpdatePrometheusAlertRule": { @@ -1098,8 +1133,8 @@ "deprecated": false }, "UpdateTimingSyntheticTask": { - "title": null, - "summary": null, + "title": "UpdateTimingSyntheticTask", + "summary": "", "deprecated": false }, "UpdateWebhook": { diff --git a/en-US/bssopenapi/SetRenewal.json b/en-US/bssopenapi/SetRenewal.json index 540c30c75..c76acd574 100644 --- a/en-US/bssopenapi/SetRenewal.json +++ b/en-US/bssopenapi/SetRenewal.json @@ -16,7 +16,7 @@ "description": "The code of the service.", "position": "Query", "type": "String", - "required": false + "required": true }, { "name": "ProductType", diff --git a/en-US/cbn/AddTrafficMatchRuleToTrafficMarkingPolicy.json b/en-US/cbn/AddTrafficMatchRuleToTrafficMarkingPolicy.json index 8bb697bb1..d34318cdb 100644 --- a/en-US/cbn/AddTrafficMatchRuleToTrafficMarkingPolicy.json +++ b/en-US/cbn/AddTrafficMatchRuleToTrafficMarkingPolicy.json @@ -28,7 +28,7 @@ }, { "name": "TrafficMatchRules", - "description": "The traffic classification rules.\n\nYou can specify at most 50 traffic classification rules.", + "description": "The traffic classification rules.\n\nYou can specify up to 50 traffic classification rules at a time.", "position": "Query", "type": "RepeatList", "required": false, diff --git a/en-US/cbn/CreateCenChildInstanceRouteEntryToAttachment.json b/en-US/cbn/CreateCenChildInstanceRouteEntryToAttachment.json index 016cb2f88..22d8ddc50 100644 --- a/en-US/cbn/CreateCenChildInstanceRouteEntryToAttachment.json +++ b/en-US/cbn/CreateCenChildInstanceRouteEntryToAttachment.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "CenId", - "description": "The ID of the Cloud Enterprise Network (CEN) instance.", + "description": "The CEN instance ID.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cbn/CreateCenChildInstanceRouteEntryToCen.json b/en-US/cbn/CreateCenChildInstanceRouteEntryToCen.json index e3ac9adf2..eb62c5225 100644 --- a/en-US/cbn/CreateCenChildInstanceRouteEntryToCen.json +++ b/en-US/cbn/CreateCenChildInstanceRouteEntryToCen.json @@ -14,7 +14,7 @@ }, { "name": "ChildInstanceAliUid", - "description": "The ID of the Alibaba Cloud account to which the network instance belongs.\n\n> If the network instance belongs to another Alibaba Cloud account, this parameter is required.", + "description": "The ID of the Alibaba Cloud account to which the network instance belongs.\n\n> If the network instance belongs to another Alibaba Cloud account, this parameter is required.", "position": "Query", "type": "Long", "required": false @@ -28,28 +28,28 @@ }, { "name": "ChildInstanceRegionId", - "description": "The ID of the region where the network instance is deployed.\n\nYou can call the [DescribeRegions](~~36063~~) operation to query the most recent region list.", + "description": "The ID of the region where the network instance is deployed.\n\nYou can call the [DescribeRegions](~~DescribeRegions~~) operation to query the most recent region list.", "position": "Query", "type": "String", "required": true }, { "name": "ChildInstanceType", - "description": "The type of the network instance. Valid values:\n\n* **VPC**: a virtual private cloud (VPC)\n* **VBR**: a virtual border router (VBR)", + "description": "The type of the attached network instance. Valid values:\n\n* **VPC**: a virtual private cloud (VPC)\n* **VBR**: a virtual border router (VBR)", "position": "Query", "type": "String", "required": true }, { "name": "DestinationCidrBlock", - "description": "The destination CIDR block of the route.\n\nSpecify the value of this parameter in CIDR notation. Example: 192.168.10.0/24.", + "description": "The destination CIDR block of the route entry.\n\nSpecify the value of this parameter in CIDR notation. Example: 192.168.10.0/24.", "position": "Query", "type": "String", "required": true }, { "name": "RouteTableId", - "description": "The ID of the route table configured on the network instance.", + "description": "The ID of the route table of the network instance.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cbn/CreateCenRouteMap.json b/en-US/cbn/CreateCenRouteMap.json index 4ae335a6c..c4eee16b4 100644 --- a/en-US/cbn/CreateCenRouteMap.json +++ b/en-US/cbn/CreateCenRouteMap.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "AsPathMatchMode", - "description": "The match method that is used to match routes against the AS paths. Valid values:\n\n* **Include**: fuzzy match. A route meets the match condition if the AS path of the route overlaps with the AS paths specified in the match condition.\n* **Complete**: exact match. A route is a match only if the AS path of the route is the same as an AS path specified in the match condition.", + "description": "The match method that is used to match routes based on AS paths. Valid values:\n\n* **Include**: fuzzy match. A route meets the match condition if the AS path of the route overlaps with the AS path specified in the match condition.\n* **Complete**: exact match. A route is a match only if the AS path of the route is the same as an AS path specified in the match condition.", "position": "Query", "type": "String", "required": false @@ -28,14 +28,14 @@ }, { "name": "CidrMatchMode", - "description": "The match method that is used to match routes against the prefix list. Valid values:\n\n* **Include**: fuzzy match. A route is a match if the route prefix is included in the match conditions.\n\n For example, if you set the match condition to 10.10.0.0/16 and fuzzy match is enabled, the route whose prefix is 10.10.1.0/24 is a match.\n\n* **Complete**: exact match. A route is a match only if the route prefix is the same as the prefix specified in the match condition.\n\n For example, if you set the match condition to 10.10.0.0/16 and exact match is enabled, a route is a match only if the prefix is 10.10.0.0/16.", + "description": "The match method that is used to match routes against the prefix list. Valid values:\n\n* **Include**: fuzzy match. A route is a match if the route prefix is included in the match conditions.\n\nFor example, if you set the match condition to 10.10.0.0/16 and fuzzy match is applied, the route whose prefix is 10.10.1.0/24 meets the match condition.\n\n* **Complete**: exact match. A route is a match only if the route prefix is the same as the prefix specified in the match condition.\n\nFor example, if you set the match condition to 10.10.0.0/16 and exact match is enabled, a route is a match only if the prefix is 10.10.0.0/16.", "position": "Query", "type": "String", "required": false }, { "name": "CommunityMatchMode", - "description": "The match method that is used to match routes based on the community. Valid values:\n\n* **Include**: fuzzy match. A route meets the match condition if the community of the route overlaps with the community specified in the match condition.\n* **Complete**: exact match. A route meets the match condition only if the community of the route is the same as the community specified in the match condition.", + "description": "The match method that is used to evaluate routes based on the community. Valid values:\n\n* **Include**: fuzzy match. A route meets the match condition if the community of the route overlaps with the community specified in the match condition.\n* **Complete**: exact match. A route meets the match condition only if the community of the route is the same as the community specified in the match condition.", "position": "Query", "type": "String", "required": false @@ -77,7 +77,7 @@ }, { "name": "DestinationInstanceIdsReverseMatch", - "description": "Specifies whether to exclude the destination network instance IDs. Valid values:\n\n* **false** (default value): A route is a match if its destination network instance ID is in the list specified by **DestinationInstanceIds.N**.\n* **true**: A route meets the match condition if its destination network instance ID is not in the list specified by **DestinationInstanceIds.N**.", + "description": "Specifies whether to exclude the destination network instance IDs. Valid values:\n\n* **false** (default value): A route meets the match condition if its destination network instance ID is in the list specified by **DestinationInstanceIds.N**.\n* **true**: A route meets the match condition if its destination network instance ID is not in the list specified by **DestinationInstanceIds.N**.", "position": "Query", "type": "Boolean", "required": false @@ -91,7 +91,7 @@ }, { "name": "MapResult", - "description": "The action to be performed on a route that meets all match conditions. Valid values:\n\n* **Permit**: the route is permitted.\n* **Deny**: the route is denied.", + "description": "The action to be performed on a route that meets all the match conditions. Valid values:\n\n* **Permit**: the route is permitted.\n* **Deny**: the route is denied.", "position": "Query", "type": "String", "required": true @@ -175,7 +175,7 @@ }, { "name": "SourceInstanceIdsReverseMatch", - "description": "Specifies whether to exclude the source network instance IDs. Valid values:\n\n* **false** (default value): A route is a match if its source network instance ID is in the list specified by **SourceInstanceIds.N**.\n* **true**: A route is a match if its source network instance ID is not in the list specified by **SourceInstanceIds.N**.", + "description": "Specifies whether to exclude the source network instance IDs. Valid values:\n\n* **false** (default value): A route meets the match condition if its source network instance ID is in the list specified by **SourceInstanceIds.N**.\n* **true**: A route is a match if its source network instance ID is not in the list specified by **SourceInstanceIds.N**.", "position": "Query", "type": "Boolean", "required": false @@ -203,7 +203,7 @@ }, { "name": "TransmitDirection", - "description": "The direction in which the routing policy is applied. Valid values:\n\n* **RegionIn**: Routes are advertised to the gateways in the regions that are connected by the CEN instance.\n\n For example, routes are advertised from network instances deployed in the current region or other regions to the gateway deployed in the current region.\n\n* **RegionOut**: Routes are advertised from the gateways in the regions that are connected by the CEN instance.\n\n For example, routes are advertised from the gateway deployed in the current region to network instances deployed in the same region, or to gateways deployed in other regions.", + "description": "The direction in which the routing policy is applied. Valid values:\n\n* **RegionIn**: Routes are advertised to the gateways in the regions that are connected by the CEN instance.\n\nFor example, routes are advertised from network instances deployed in the current region or other regions to the gateway deployed in the current region.\n\n* **RegionOut**: Routes are advertised from the gateways in the regions that are connected by the CEN instance.\n\nFor example, routes are advertised from the gateway deployed in the current region to network instances deployed in the same region, or to gateways deployed in other regions.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cbn/CreateTransitRouter.json b/en-US/cbn/CreateTransitRouter.json index bd39c1584..7c75e0e70 100644 --- a/en-US/cbn/CreateTransitRouter.json +++ b/en-US/cbn/CreateTransitRouter.json @@ -96,14 +96,14 @@ }, { "name": "TransitRouterDescription", - "description": "The description of the Enterprise Edition transit router.\n\nThe description must be 2 to 256 characters in length. The description must start with a letter but cannot start with `http://` or `https://`.", + "description": "The description of the Enterprise Edition transit router instance.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false }, { "name": "TransitRouterName", - "description": "The name of the Enterprise Edition transit router.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.", + "description": "The name of the Enterprise Edition transit router.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/CreateTransitRouterCidr.json b/en-US/cbn/CreateTransitRouterCidr.json index 0f510d44d..a68e595c2 100644 --- a/en-US/cbn/CreateTransitRouterCidr.json +++ b/en-US/cbn/CreateTransitRouterCidr.json @@ -20,7 +20,7 @@ }, { "name": "Description", - "description": "The description of the CIDR block.\n\nThe description must be 2 to 256 characters in length. The description must start with a letter but cannot start with `http://` or `https://`.", + "description": "The description of the transit router CIDR block.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false @@ -34,7 +34,7 @@ }, { "name": "Name", - "description": "The name of the CIDR block.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.", + "description": "The name of the transit router CIDR block.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/CreateTransitRouterMulticastDomain.json b/en-US/cbn/CreateTransitRouterMulticastDomain.json index 661aee3a6..a024fe19a 100644 --- a/en-US/cbn/CreateTransitRouterMulticastDomain.json +++ b/en-US/cbn/CreateTransitRouterMulticastDomain.json @@ -63,14 +63,14 @@ }, { "name": "TransitRouterMulticastDomainDescription", - "description": "The description of the multicast domain.\n\nThe description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (\\_), and hyphens (-).", + "description": "The description of the multicast domain.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false }, { "name": "TransitRouterMulticastDomainName", - "description": "The name of the multicast domain.\n\nThe name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (\\_), and hyphens (-).", + "description": "The name of the multicast domain.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/CreateTransitRouterRouteEntry.json b/en-US/cbn/CreateTransitRouterRouteEntry.json index e9bc765ed..5f55d26f1 100644 --- a/en-US/cbn/CreateTransitRouterRouteEntry.json +++ b/en-US/cbn/CreateTransitRouterRouteEntry.json @@ -21,7 +21,7 @@ }, { "name": "TransitRouterRouteEntryDescription", - "description": "The description of the route.\n\nThe description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (\\_), and hyphens (-).", + "description": "The description of the route.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false @@ -35,7 +35,7 @@ }, { "name": "TransitRouterRouteEntryName", - "description": "The name of the route.\n\nThe name must be 0 to 128 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ \\_ -.", + "description": "The name of the route.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/CreateTransitRouterRouteTable.json b/en-US/cbn/CreateTransitRouterRouteTable.json index cf78cbfd1..5dbf50256 100644 --- a/en-US/cbn/CreateTransitRouterRouteTable.json +++ b/en-US/cbn/CreateTransitRouterRouteTable.json @@ -56,14 +56,14 @@ }, { "name": "TransitRouterRouteTableDescription", - "description": "The description of the custom route table.\n\nThe description must be 2 to 256 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ \\_ -. You can also leave the description empty.", + "description": "The description of the custom route table.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false }, { "name": "TransitRouterRouteTableName", - "description": "The name of the custom route table.\n\nThe name must be 1 to 128 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ \\_ -. You can also leave the name empty.", + "description": "The name of the custom route table.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/CreateTransitRouterVbrAttachment.json b/en-US/cbn/CreateTransitRouterVbrAttachment.json index 982239fed..e9f759270 100644 --- a/en-US/cbn/CreateTransitRouterVbrAttachment.json +++ b/en-US/cbn/CreateTransitRouterVbrAttachment.json @@ -63,14 +63,14 @@ }, { "name": "TransitRouterAttachmentDescription", - "description": "The description of the VBR connection.\n\nThe description must be 2 to 256 characters in length. The description must start with a letter but cannot start with `http://` or `https://`.", + "description": "The description of the VBR connection.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false }, { "name": "TransitRouterAttachmentName", - "description": "The name of the VBR connection.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, underscores (\\_), and hyphens (-). It must start with a letter.", + "description": "The name of the VBR connection.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/CreateTransitRouterVpcAttachment.json b/en-US/cbn/CreateTransitRouterVpcAttachment.json index a0d6ce552..afc9291f5 100644 --- a/en-US/cbn/CreateTransitRouterVpcAttachment.json +++ b/en-US/cbn/CreateTransitRouterVpcAttachment.json @@ -70,14 +70,14 @@ }, { "name": "TransitRouterAttachmentDescription", - "description": "The description of the VPC connection.\n\nThe description must be 2 to 256 characters in length. The description must start with a letter but cannot start with `http://` or `https://`.", + "description": "The description of the VPC connection.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false }, { "name": "TransitRouterAttachmentName", - "description": "The name of the VPC connection.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, underscores (\\_), and hyphens (-). It must start with a letter.", + "description": "The name of the VPC connection.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/DeleteRouteServiceInCen.json b/en-US/cbn/DeleteRouteServiceInCen.json index d87810a82..82c600478 100644 --- a/en-US/cbn/DeleteRouteServiceInCen.json +++ b/en-US/cbn/DeleteRouteServiceInCen.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "AccessRegionId", - "description": "The ID of the region in which the network instance of the cloud service that you want to access is deployed.\n\nYou can call the [DescribeRegions](~~36063~~) operation to query the most recent region list.", + "description": "The ID of the region where the cloud service is accessed.", "position": "Query", "type": "String", "required": true @@ -28,7 +28,7 @@ }, { "name": "HostRegionId", - "description": "The ID of the region in which the cloud service is deployed.", + "description": "The region ID of the cloud service.\n\nYou can call the [DescribeRegions](~~36063~~) operation to query the most recent region list.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cbn/DeleteTransitRouteTableAggregation.json b/en-US/cbn/DeleteTransitRouteTableAggregation.json index 99b5edefa..5ba133e2f 100644 --- a/en-US/cbn/DeleteTransitRouteTableAggregation.json +++ b/en-US/cbn/DeleteTransitRouteTableAggregation.json @@ -7,28 +7,28 @@ "parameters": [ { "name": "ClientToken", - "description": "", + "description": "The client token that is used to ensure the idempotence of the request.\n\nYou can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.\n\n> If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.", "position": "Query", "type": "String", "required": false }, { "name": "DryRun", - "description": "", + "description": "Specifies whether to perform only a dry run, without performing the actual request. Default values:\n\n* **false** (default): performs only a dry run.\n* **true**: performs a dry run and performs the actual request. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.", "position": "Query", "type": "Boolean", "required": false }, { "name": "TransitRouteTableAggregationCidr", - "description": "", + "description": "The destination CIDR block of the aggregate route.\n\n> The following CIDR blocks are not supported:\n>* CIDR blocks that start with 0 or 100.64.\n>* Multicast CIDR blocks, including 224.0.0.1 to 239.255.255.254.", "position": "Query", "type": "String", "required": true }, { "name": "TransitRouteTableId", - "description": "", + "description": "The ID of the route table of the Enterprise Edition transit router.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cbn/DeleteTransitRouterMulticastDomain.json b/en-US/cbn/DeleteTransitRouterMulticastDomain.json index df9dca983..5e02a1636 100644 --- a/en-US/cbn/DeleteTransitRouterMulticastDomain.json +++ b/en-US/cbn/DeleteTransitRouterMulticastDomain.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "ClientToken", - "description": "", + "description": "The client token that is used to ensure the idempotence of the request.\n\nYou can use the client to generate the value, but you must make sure that the value is unique among different requests. The client token can contain only ASCII characters.", "position": "Query", "type": "String", "required": false }, { "name": "DryRun", - "description": "", + "description": "Specifies whether to perform a dry run. Valid values:\n\n* **true**: performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.\n* **false** (default): performs a dry run and sends the request.", "position": "Query", "type": "Boolean", "required": false }, { "name": "TransitRouterMulticastDomainId", - "description": "", + "description": "The ID of the multicast domain.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cbn/DescribeCenVbrHealthCheck.json b/en-US/cbn/DescribeCenVbrHealthCheck.json index 287b77b37..9c84bf944 100644 --- a/en-US/cbn/DescribeCenVbrHealthCheck.json +++ b/en-US/cbn/DescribeCenVbrHealthCheck.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "CenId", - "description": "The ID of the CEN instance.", + "description": "The ID of the Cloud Enterprise Network (CEN) instance.", "position": "Query", "type": "String", "required": false @@ -35,14 +35,14 @@ }, { "name": "VbrInstanceOwnerId", - "description": "The ID of the Alibaba Cloud account that owns the VBR.", + "description": "The ID of the Alibaba Cloud account that owns the VBRs.", "position": "Query", "type": "Long", "required": false }, { "name": "VbrInstanceRegionId", - "description": "The ID of the region where the VBR is deployed.\n\nYou can call the [DescribeChildInstanceRegions](~~132080~~) operation to query the most recent region list.", + "description": "The ID of the region where the VBRs are deployed.\n\nYou can call the [DescribeChildInstanceRegions](~~132080~~) operation to query the most recent region list.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cbn/DescribeFlowlogs.json b/en-US/cbn/DescribeFlowlogs.json index bf04a862e..2da40b04e 100644 --- a/en-US/cbn/DescribeFlowlogs.json +++ b/en-US/cbn/DescribeFlowlogs.json @@ -49,14 +49,14 @@ }, { "name": "PageNumber", - "description": "The number of the page to return. Default value: **1**.", + "description": "The page number. Default value: **1**.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "The number of entries to return on each page. Minimum value: **1**. Default value: **20**.", + "description": "The number of entries per page. Minimum value: **1**. Default value: **20**.", "position": "Query", "type": "Integer", "required": false diff --git a/en-US/cbn/DescribeGrantRulesToCen.json b/en-US/cbn/DescribeGrantRulesToCen.json index 57f245f24..fe4f56394 100644 --- a/en-US/cbn/DescribeGrantRulesToCen.json +++ b/en-US/cbn/DescribeGrantRulesToCen.json @@ -52,7 +52,7 @@ "description": "The region ID of the network instance.\n\nYou can call the [DescribeChildInstanceRegions](~~132080~~) operation to query the most recent region list.", "position": "Query", "type": "String", - "required": true + "required": false } ] } \ No newline at end of file diff --git a/en-US/cbn/DescribeGrantRulesToResource.json b/en-US/cbn/DescribeGrantRulesToResource.json index 2899715de..7c0af8f75 100644 --- a/en-US/cbn/DescribeGrantRulesToResource.json +++ b/en-US/cbn/DescribeGrantRulesToResource.json @@ -31,7 +31,7 @@ "description": "The region ID of the network instance.\n\nYou can call the [DescribeChildInstanceRegions](~~132080~~) operation to query the most recent region list.", "position": "Query", "type": "String", - "required": true + "required": false }, { "name": "ResourceId", diff --git a/en-US/cbn/DescribeRouteServicesInCen.json b/en-US/cbn/DescribeRouteServicesInCen.json index cf2f7df86..36dd7c83e 100644 --- a/en-US/cbn/DescribeRouteServicesInCen.json +++ b/en-US/cbn/DescribeRouteServicesInCen.json @@ -14,7 +14,7 @@ }, { "name": "CenId", - "description": "The ID of the CEN instance.", + "description": "The ID of the Cloud Enterprise Network (CEN) instance.", "position": "Query", "type": "String", "required": true @@ -28,14 +28,14 @@ }, { "name": "HostRegionId", - "description": "The ID of the region where the cloud service is deployed.\n\nYou can call the [DescribeChildInstanceRegions](~~132080~~) operation to query the most recent region list.", + "description": "The region ID of the cloud service.\n\nYou can call the [DescribeChildInstanceRegions](~~132080~~) operation to query the most recent region list.", "position": "Query", "type": "String", "required": false }, { "name": "HostVpcId", - "description": "The ID of the virtual private cloud (VPC) that is associated with the cloud service.", + "description": "The ID of the VPC associated with the cloud service.", "position": "Query", "type": "String", "required": false @@ -49,7 +49,7 @@ }, { "name": "PageSize", - "description": "The number of entries to return per page. Default value: **10**. Valid values: **1** to **50**.", + "description": "The number of entries per page. Default value: **10**. Valid values: **1** to **50**.", "position": "Query", "type": "Integer", "required": false diff --git a/en-US/cbn/EnableCenVbrHealthCheck.json b/en-US/cbn/EnableCenVbrHealthCheck.json index a710e0832..658dd5f3e 100644 --- a/en-US/cbn/EnableCenVbrHealthCheck.json +++ b/en-US/cbn/EnableCenVbrHealthCheck.json @@ -11,6 +11,13 @@ "type": "String", "required": true }, + { + "name": "Description", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "HealthCheckInterval", "description": "The time interval at which probe packets are sent during a health check. Unit: seconds. Default value: **2**. Valid values: **2 to 3**.", diff --git a/en-US/cbn/GrantInstanceToTransitRouter.json b/en-US/cbn/GrantInstanceToTransitRouter.json index baf83c2c6..a8a28a89c 100644 --- a/en-US/cbn/GrantInstanceToTransitRouter.json +++ b/en-US/cbn/GrantInstanceToTransitRouter.json @@ -45,7 +45,7 @@ "description": "The ID of the region where the network instance is deployed.\n\nYou can call the [DescribeChildInstanceRegions](~~132080~~) operation to query the most recent region list.", "position": "Query", "type": "String", - "required": true + "required": false } ] } \ No newline at end of file diff --git a/en-US/cbn/ModifyCenBandwidthPackageAttribute.json b/en-US/cbn/ModifyCenBandwidthPackageAttribute.json index 9f19b2667..cae5c23d3 100644 --- a/en-US/cbn/ModifyCenBandwidthPackageAttribute.json +++ b/en-US/cbn/ModifyCenBandwidthPackageAttribute.json @@ -14,14 +14,14 @@ }, { "name": "Description", - "description": "The new description of the bandwidth plan.\n\nThe description must be 2 to 256 characters in length. It must start with a letter and cannot start with `http://` or `https://`.", + "description": "The new description of the bandwidth plan.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false }, { "name": "Name", - "description": "The new name of the bandwidth plan.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, underscores (\\_), and hyphens (-). The name must start with a letter and cannot start with `http://` or `https://`.", + "description": "The new name of the bandwidth plan.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/ModifyFlowLogAttribute.json b/en-US/cbn/ModifyFlowLogAttribute.json index a5f59c30e..05e3db7d6 100644 --- a/en-US/cbn/ModifyFlowLogAttribute.json +++ b/en-US/cbn/ModifyFlowLogAttribute.json @@ -21,7 +21,7 @@ }, { "name": "Description", - "description": "The new description of the flow log.\n\nThe description must be 2 to 256 characters in length. It must start with a letter but cannot start with `http://` or `https://`.", + "description": "The new description of the flow log.\n\nThe description can be empty or 1 to 256 characters in length, and cannot start with http:// or https://.", "position": "Query", "type": "String", "required": false @@ -35,7 +35,7 @@ }, { "name": "FlowLogName", - "description": "The new name of the flow log.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.", + "description": "The new name of the flow log.\n\nThe name can be empty or 1 to 128 characters in length, and cannot start with http:// or https://.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/ModifyTransitRouterCidr.json b/en-US/cbn/ModifyTransitRouterCidr.json index 4d7660e77..6ad975789 100644 --- a/en-US/cbn/ModifyTransitRouterCidr.json +++ b/en-US/cbn/ModifyTransitRouterCidr.json @@ -20,7 +20,7 @@ }, { "name": "Description", - "description": "The new description of the transit router CIDR block.\n\nThe description must be 1 to 256 characters in length.", + "description": "The new description of the transit router CIDR block.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false @@ -34,7 +34,7 @@ }, { "name": "Name", - "description": "The new name of the transit router CIDR block.\n\nThe name must be 1 to 128 characters in length.", + "description": "The new name of the transit router CIDR block.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/RevokeInstanceFromTransitRouter.json b/en-US/cbn/RevokeInstanceFromTransitRouter.json index aa9af00be..399ad45de 100644 --- a/en-US/cbn/RevokeInstanceFromTransitRouter.json +++ b/en-US/cbn/RevokeInstanceFromTransitRouter.json @@ -38,7 +38,7 @@ "description": "The region ID of the network instance.\n\nYou can call the [DescribeChildInstanceRegions](~~132080~~) operation to query the most recent region list.", "position": "Query", "type": "String", - "required": true + "required": false } ] } \ No newline at end of file diff --git a/en-US/cbn/UpdateCenInterRegionTrafficQosQueueAttribute.json b/en-US/cbn/UpdateCenInterRegionTrafficQosQueueAttribute.json index 61982eea7..034a344e3 100644 --- a/en-US/cbn/UpdateCenInterRegionTrafficQosQueueAttribute.json +++ b/en-US/cbn/UpdateCenInterRegionTrafficQosQueueAttribute.json @@ -28,7 +28,7 @@ }, { "name": "QosQueueDescription", - "description": "The new description of the queue.\n\nThe description must be 2 to 128 characters in length, and can contain letters, digits, underscores (\\_), and hyphens (-). The description must start with a letter.", + "description": "The new description of the queue.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false @@ -42,7 +42,7 @@ }, { "name": "QosQueueName", - "description": "The new name of the queue.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, underscores (\\_), and hyphens (-). It must start with a letter.", + "description": "The new name of the queue.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/UpdateTransitRouter.json b/en-US/cbn/UpdateTransitRouter.json index 779326245..0e883a6c2 100644 --- a/en-US/cbn/UpdateTransitRouter.json +++ b/en-US/cbn/UpdateTransitRouter.json @@ -28,7 +28,7 @@ }, { "name": "TransitRouterDescription", - "description": "The description of the transit router.\n\nThe description must be 2 to 256 characters in length. The description must start with a letter but cannot start with `http://` or `https://`.", + "description": "The description of the transit router.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false @@ -42,7 +42,7 @@ }, { "name": "TransitRouterName", - "description": "The transit router name.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.", + "description": "The transit router name.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/UpdateTransitRouterRouteEntry.json b/en-US/cbn/UpdateTransitRouterRouteEntry.json index c7e11ca73..9d97b2644 100644 --- a/en-US/cbn/UpdateTransitRouterRouteEntry.json +++ b/en-US/cbn/UpdateTransitRouterRouteEntry.json @@ -21,7 +21,7 @@ }, { "name": "TransitRouterRouteEntryDescription", - "description": "The new description of the route.\n\nThe description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (\\_), and hyphens (-).", + "description": "The new description of the route.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false @@ -35,7 +35,7 @@ }, { "name": "TransitRouterRouteEntryName", - "description": "The new name of the route.\n\nThe name must be 1 to 128 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ \\_ -. You can also leave the name empty.", + "description": "The new name of the route.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/UpdateTransitRouterRouteTable.json b/en-US/cbn/UpdateTransitRouterRouteTable.json index 9baf58a1e..8c21ddf0e 100644 --- a/en-US/cbn/UpdateTransitRouterRouteTable.json +++ b/en-US/cbn/UpdateTransitRouterRouteTable.json @@ -28,7 +28,7 @@ }, { "name": "TransitRouterRouteTableDescription", - "description": "The description of the route table.\n\nThe description must be 2 to 256 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ \\_ -. You can also leave the description empty.", + "description": "The description of the route table.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false @@ -42,7 +42,7 @@ }, { "name": "TransitRouterRouteTableName", - "description": "The name of the route table.\n\nThe name must be 1 to 128 characters in length, and can contain letters, digits, and the following special characters: , . ; / @ \\_ -. You can also leave the name empty.", + "description": "The name of the route table.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/UpdateTransitRouterVbrAttachmentAttribute.json b/en-US/cbn/UpdateTransitRouterVbrAttachmentAttribute.json index 4648eca0f..1b0da34ce 100644 --- a/en-US/cbn/UpdateTransitRouterVbrAttachmentAttribute.json +++ b/en-US/cbn/UpdateTransitRouterVbrAttachmentAttribute.json @@ -28,7 +28,7 @@ }, { "name": "TransitRouterAttachmentDescription", - "description": "The new description of the VBR connection.\n\nThe description must be 2 to 256 characters in length. The description must start with a letter but cannot start with `http://` or `https://`.", + "description": "The new description of the VBR connection.\n\nThe description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false @@ -42,7 +42,7 @@ }, { "name": "TransitRouterAttachmentName", - "description": "The new name of the VBR connection.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, underscores (\\_), and hyphens (-). The name must start with a letter.", + "description": "The new name of the VBR connection.\n\nThe name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/UpdateTransitRouterVpnAttachmentAttribute.json b/en-US/cbn/UpdateTransitRouterVpnAttachmentAttribute.json index 4a12dcba9..60b8f0ded 100644 --- a/en-US/cbn/UpdateTransitRouterVpnAttachmentAttribute.json +++ b/en-US/cbn/UpdateTransitRouterVpnAttachmentAttribute.json @@ -27,7 +27,7 @@ }, { "name": "TransitRouterAttachmentDescription", - "description": "The new description of the VPN attachment.\n\nThe description must be 2 to 256 characters in length. The description must start with a letter but cannot start with `http://` or `https://`.", + "description": "The new description of the VPN connection.\n\nThe description can be empty or 1 to 256 characters in length, and cannot start with http:// or https://.", "position": "Query", "type": "String", "required": false @@ -41,7 +41,7 @@ }, { "name": "TransitRouterAttachmentName", - "description": "The name of the VPN attachment.\n\nThe name must be 2 to 128 characters in length, and can contain letters, digits, underscores (\\_), and hyphens (-). It must start with a letter.", + "description": "The name of the VPN connection.\n\nThe name can be empty or 1 to 128 characters in length, and cannot start with http:// or https://.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cbn/version.json b/en-US/cbn/version.json index 267531b17..fee149720 100644 --- a/en-US/cbn/version.json +++ b/en-US/cbn/version.json @@ -189,12 +189,12 @@ }, "DeleteRouteServiceInCen": { "title": "DeleteRouteServiceInCen", - "summary": "Deletes the configuration of a cloud service.", + "summary": "Deletes the configuration of a cloud service connected to a Basic Edition transit router.", "deprecated": false }, "DeleteTrafficMarkingPolicy": { "title": "DeleteTrafficMarkingPolicy", - "summary": "Deletes a traffic marking policy.", + "summary": "Deletes a specified traffic marking policy.", "deprecated": false }, "DeleteTransitRouteTableAggregation": { @@ -259,7 +259,7 @@ }, "DeregisterTransitRouterMulticastGroupSources": { "title": "DeregisterTransitRouterMulticastGroupSources", - "summary": "Deletes multicast sources.", + "summary": "Deletes a multicast source from a multicast group.", "deprecated": false }, "DescribeCenAttachedChildInstanceAttribute": { @@ -314,7 +314,7 @@ }, "DescribeCenVbrHealthCheck": { "title": "DescribeCenVbrHealthCheck", - "summary": "Queries the health check configuration of a virtual border router (VBR) in a specified region.", + "summary": "Queries the health check configurations of virtual border routers (VBRs) in a region.", "deprecated": false }, "DescribeCens": { @@ -359,7 +359,7 @@ }, "DescribeRouteServicesInCen": { "title": "DescribeRouteServicesInCen", - "summary": "Queries the cloud services that are configured on a Cloud Enterprise Network (CEN) instance.", + "summary": "Queries the configurations of cloud services, such as the cloud service status and the ID of the associated VPC.", "deprecated": false }, "DescribeTransitRouteTableAggregation": { @@ -624,7 +624,7 @@ }, "RoutePrivateZoneInCenToVpc": { "title": "RoutePrivateZoneInCenToVpc", - "summary": "Enables access to PrivateZone.", + "summary": "Configures PrivateZone.", "deprecated": false }, "SetCenInterRegionBandwidthLimit": { @@ -659,7 +659,7 @@ }, "UpdateCenInterRegionTrafficQosPolicyAttribute": { "title": "UpdateCenInterRegionTrafficQosPolicyAttribute", - "summary": "Modifies the name and description of a quality of service (QoS) policy.", + "summary": "Modifies the name and description of a QoS policy.", "deprecated": false }, "UpdateCenInterRegionTrafficQosQueueAttribute": { diff --git a/en-US/cdn/DescribeUserDomains.json b/en-US/cdn/DescribeUserDomains.json index 1ee322fc2..388640611 100644 --- a/en-US/cdn/DescribeUserDomains.json +++ b/en-US/cdn/DescribeUserDomains.json @@ -62,14 +62,14 @@ }, { "name": "PageNumber", - "description": "The number of the page to return. Valid values: **1** to **100000**.", + "description": "The page number. Valid values: **1** to **100000**.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "The number of entries to return on each page. Valid values: **1 to 50**. Default value: **20**. Maximum value: **50**.", + "description": "The number of entries to return on each page. Valid values: **1 to 500**. Default value: **20**. Maximum value: **500**.", "position": "Query", "type": "Integer", "required": false diff --git a/en-US/cdn/version.json b/en-US/cdn/version.json index fca70e1a4..7baebd28c 100644 --- a/en-US/cdn/version.json +++ b/en-US/cdn/version.json @@ -539,6 +539,7 @@ }, "DescribeDomainVerifyData": { "title": "DescribeDomainVerifyData", + "summary": "Queries the verification content of a domain name, including the host record and record value.", "deprecated": false }, "DescribeDomainsBySource": { diff --git a/en-US/cloudapi/AddAccessControlListEntry.json b/en-US/cloudapi/AddAccessControlListEntry.json index 3888a379d..b6abf57af 100644 --- a/en-US/cloudapi/AddAccessControlListEntry.json +++ b/en-US/cloudapi/AddAccessControlListEntry.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "AclEntrys", - "description": "", + "description": "The ACL settings.\n\n* entry: the entries that you want to add to the ACL. You can add CIDR blocks. Separate multiple CIDR blocks with commas (,).\n* comment: the description of the ACL.\n\n> You can add at most 50 IP addresses or CIDR blocks to an ACL in each call. If the IP address or CIDR block that you want to add to an ACL already exists, the IP address or CIDR block is not added. The entries that you add must be CIDR blocks.", "position": "Query", "type": "String", "required": false }, { "name": "AclId", - "description": "", + "description": "The ID of the access control list (ACL).", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/BatchAbolishApis.json b/en-US/cloudapi/BatchAbolishApis.json index c21c0a06c..d09da1b40 100644 --- a/en-US/cloudapi/BatchAbolishApis.json +++ b/en-US/cloudapi/BatchAbolishApis.json @@ -6,7 +6,7 @@ "parameters": [ { "name": "Api", - "description": "", + "description": "The APIs that you want to operate.", "position": "Query", "type": "RepeatList", "required": true, diff --git a/en-US/cloudapi/CreateApi.json b/en-US/cloudapi/CreateApi.json index 76b282abc..5c14a3acc 100644 --- a/en-US/cloudapi/CreateApi.json +++ b/en-US/cloudapi/CreateApi.json @@ -182,7 +182,7 @@ }, { "name": "Tag", - "description": "", + "description": "The list of tags.", "position": "Query", "type": "RepeatList", "required": false, diff --git a/en-US/cloudapi/CreateDataset.json b/en-US/cloudapi/CreateDataset.json index a160312f5..cbf89f668 100644 --- a/en-US/cloudapi/CreateDataset.json +++ b/en-US/cloudapi/CreateDataset.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "DatasetName", - "description": "", + "description": "The name of the dataset.", "position": "Query", "type": "String", "required": true }, { "name": "DatasetType", - "description": "", + "description": "The type of the dataset. Valid values:\n\n* JWT_BLOCKING: a JSON Web Token (JWT) blacklist\n* IP_WHITELIST_CIDR : an IP address whitelist\n* PARAMETER_ACCESS : parameter-based access control", "position": "Query", "type": "String", "required": true @@ -28,7 +28,7 @@ }, { "name": "Tag", - "description": "", + "description": "The tag of objects that match the rule. You can specify multiple tags.", "position": "Query", "type": "RepeatList", "required": false, diff --git a/en-US/cloudapi/CreateModel.json b/en-US/cloudapi/CreateModel.json index bcda25aaf..6df23a491 100644 --- a/en-US/cloudapi/CreateModel.json +++ b/en-US/cloudapi/CreateModel.json @@ -34,7 +34,7 @@ }, { "name": "Tag", - "description": "", + "description": "The object tags that match the lifecycle rule. You can specify multiple tags.", "position": "Query", "type": "RepeatList", "required": false, diff --git a/en-US/cloudapi/CreateMonitorGroup.json b/en-US/cloudapi/CreateMonitorGroup.json index b71e549fa..b3c569513 100644 --- a/en-US/cloudapi/CreateMonitorGroup.json +++ b/en-US/cloudapi/CreateMonitorGroup.json @@ -6,21 +6,21 @@ "parameters": [ { "name": "Auth", - "description": "", + "description": "The caller authentication status of the API. Valid values: **ok**: The authentication is successful. **mismatch**: The request is redirected. **servicenotfound**: A request error occurred. **Unknown**: An unknown error occurred.", "position": "Query", "type": "String", "required": true }, { "name": "GroupId", - "description": "", + "description": "The ID of the API group.", "position": "Query", "type": "String", "required": true }, { "name": "RawMonitorGroupId", - "description": "", + "description": "The ID of the monitoring group.", "position": "Query", "type": "Long", "required": false diff --git a/en-US/cloudapi/DeleteBackend.json b/en-US/cloudapi/DeleteBackend.json index f19d407cc..effd3b4fe 100644 --- a/en-US/cloudapi/DeleteBackend.json +++ b/en-US/cloudapi/DeleteBackend.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "BackendId", - "description": "", + "description": "The ID of the backend service.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudapi/DeleteDatasetItem.json b/en-US/cloudapi/DeleteDatasetItem.json index 8fe656b7d..74b322dc8 100644 --- a/en-US/cloudapi/DeleteDatasetItem.json +++ b/en-US/cloudapi/DeleteDatasetItem.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "DatasetId", - "description": "", + "description": "The ID of the dataset.", "position": "Query", "type": "String", "required": true }, { "name": "DatasetItemId", - "description": "", + "description": "The ID of the data entry.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/DeleteDomainCertificate.json b/en-US/cloudapi/DeleteDomainCertificate.json index f62426927..054993512 100644 --- a/en-US/cloudapi/DeleteDomainCertificate.json +++ b/en-US/cloudapi/DeleteDomainCertificate.json @@ -6,21 +6,21 @@ "parameters": [ { "name": "CertificateId", - "description": "", + "description": "The ID of the SSL certificate that you want to delete. The ID is automatically generated by the system and globally unique.", "position": "Query", "type": "String", "required": true }, { "name": "DomainName", - "description": "", + "description": "The custom domain name.", "position": "Query", "type": "String", "required": true }, { "name": "GroupId", - "description": "", + "description": "The ID of the API group. This ID is generated by the system and globally unique.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/DeleteMonitorGroup.json b/en-US/cloudapi/DeleteMonitorGroup.json index c82d64e42..056d524ff 100644 --- a/en-US/cloudapi/DeleteMonitorGroup.json +++ b/en-US/cloudapi/DeleteMonitorGroup.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "GroupId", - "description": "", + "description": "The ID of the API group. This ID is generated by the system and globally unique.", "position": "Query", "type": "String", "required": true }, { "name": "RawMonitorGroupId", - "description": "", + "description": "The ID of the monitoring group.", "position": "Query", "type": "Long", "required": false diff --git a/en-US/cloudapi/DescribeAccessControlLists.json b/en-US/cloudapi/DescribeAccessControlLists.json index e5d7e034a..6ee08657a 100644 --- a/en-US/cloudapi/DescribeAccessControlLists.json +++ b/en-US/cloudapi/DescribeAccessControlLists.json @@ -7,28 +7,28 @@ "parameters": [ { "name": "AclName", - "description": "", + "description": "The name of the access control policy.", "position": "Query", "type": "String", "required": false }, { "name": "AddressIPVersion", - "description": "", + "description": "IP版本，可以设置为**ipv4**或者**ipv6**。", "position": "Query", "type": "String", "required": false }, { "name": "PageNumber", - "description": "", + "description": "The page number of the current page.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "", + "description": "The number of entries to return on each page.", "position": "Query", "type": "Integer", "required": false diff --git a/en-US/cloudapi/DescribeApiGroupVpcWhitelist.json b/en-US/cloudapi/DescribeApiGroupVpcWhitelist.json index df678d27e..d9ea05288 100644 --- a/en-US/cloudapi/DescribeApiGroupVpcWhitelist.json +++ b/en-US/cloudapi/DescribeApiGroupVpcWhitelist.json @@ -6,7 +6,7 @@ "parameters": [ { "name": "GroupId", - "description": "", + "description": "The ID of the API group.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/DescribeApiMarketAttributes.json b/en-US/cloudapi/DescribeApiMarketAttributes.json index f14dbb57b..a5858b6b4 100644 --- a/en-US/cloudapi/DescribeApiMarketAttributes.json +++ b/en-US/cloudapi/DescribeApiMarketAttributes.json @@ -6,14 +6,14 @@ "parameters": [ { "name": "ApiId", - "description": "", + "description": "The ID of the API.", "position": "Query", "type": "String", "required": true }, { "name": "GroupId", - "description": "", + "description": "The ID of the API group.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/DescribeApisByBackend.json b/en-US/cloudapi/DescribeApisByBackend.json index 926f65e70..f3a5fcc86 100644 --- a/en-US/cloudapi/DescribeApisByBackend.json +++ b/en-US/cloudapi/DescribeApisByBackend.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "BackendId", - "description": "", + "description": "The ID of the backend service.", "position": "Query", "type": "String", "required": true }, { "name": "PageNumber", - "description": "", + "description": "The number of the current page.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "", + "description": "The number of entries to return on each page.", "position": "Query", "type": "Integer", "required": false @@ -35,7 +35,7 @@ }, { "name": "StageName", - "description": "", + "description": "The environment to which the API is published. Valid values:\n\n* **RELEASE**\n* **PRE**\n* **TEST**\n\nIf you do not specify this parameter, APIs in the draft state are returned.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudapi/DescribeAppSecurity.json b/en-US/cloudapi/DescribeAppSecurity.json index 69887b6c6..360744206 100644 --- a/en-US/cloudapi/DescribeAppSecurity.json +++ b/en-US/cloudapi/DescribeAppSecurity.json @@ -6,7 +6,7 @@ "parameters": [ { "name": "AppId", - "description": "", + "description": "The ID of the app.", "position": "Query", "type": "Long", "required": true @@ -20,7 +20,7 @@ }, { "name": "Tag", - "description": "", + "description": "The tag of objects that match the rule. You can specify multiple tags.", "position": "Query", "type": "RepeatList", "required": false, diff --git a/en-US/cloudapi/DescribeDeployApiTask.json b/en-US/cloudapi/DescribeDeployApiTask.json index 3ef83bc3e..ce9cbb53f 100644 --- a/en-US/cloudapi/DescribeDeployApiTask.json +++ b/en-US/cloudapi/DescribeDeployApiTask.json @@ -6,7 +6,7 @@ "parameters": [ { "name": "OperationUid", - "description": "", + "description": "The task ID.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/DescribeMarketRemainsQuota.json b/en-US/cloudapi/DescribeMarketRemainsQuota.json index f1c425ecc..2f2dc2c59 100644 --- a/en-US/cloudapi/DescribeMarketRemainsQuota.json +++ b/en-US/cloudapi/DescribeMarketRemainsQuota.json @@ -6,7 +6,7 @@ "parameters": [ { "name": "DomainName", - "description": "", + "description": "The custom domain name.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/DescribePurchasedApiGroup.json b/en-US/cloudapi/DescribePurchasedApiGroup.json index 66646b6c1..b085a5ec0 100644 --- a/en-US/cloudapi/DescribePurchasedApiGroup.json +++ b/en-US/cloudapi/DescribePurchasedApiGroup.json @@ -6,7 +6,7 @@ "parameters": [ { "name": "GroupId", - "description": "", + "description": "The ID of the API group. This ID is generated by the system and globally unique.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/DescribeVpcAccesses.json b/en-US/cloudapi/DescribeVpcAccesses.json index 87c5b2cff..6e00daa5f 100644 --- a/en-US/cloudapi/DescribeVpcAccesses.json +++ b/en-US/cloudapi/DescribeVpcAccesses.json @@ -7,35 +7,35 @@ "parameters": [ { "name": "InstanceId", - "description": "", + "description": "The ID of the instance.", "position": "Query", "type": "String", "required": false }, { "name": "Name", - "description": "", + "description": "The name of the authorization. The name must be unique.", "position": "Query", "type": "String", "required": false }, { "name": "PageNumber", - "description": "", + "description": "The number of the page to return. Pages start from page 1. Default value: 1.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "", + "description": "The number of entries to return on each page. Maximum value: 100. Default value: 10.", "position": "Query", "type": "Integer", "required": false }, { "name": "Port", - "description": "", + "description": "The service port.", "position": "Query", "type": "String", "required": false @@ -49,7 +49,7 @@ }, { "name": "Tag", - "description": "", + "description": "The tag of objects that match the rule. You can specify multiple tags.", "position": "Query", "type": "RepeatList", "required": false, @@ -70,14 +70,14 @@ }, { "name": "VpcAccessId", - "description": "", + "description": "The ID of the VPC authorization.", "position": "Query", "type": "String", "required": false }, { "name": "VpcId", - "description": "", + "description": "The ID of the VPC.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudapi/ImportOAS.json b/en-US/cloudapi/ImportOAS.json index 40c31e29f..bb661a2b9 100644 --- a/en-US/cloudapi/ImportOAS.json +++ b/en-US/cloudapi/ImportOAS.json @@ -7,56 +7,56 @@ "parameters": [ { "name": "AuthType", - "description": "API安全认证类型，目前可以取值：\n\n- **APP**：只允许已授权的APP调用\n- **ANONYMOUS**：允许匿名调用，设置为允许匿名调用需要注意：\n - 任何能够获取该API服务信息的人，都将能够调用该API。网关不会对调用者做身份认证，也无法设置按用户的流量控制，若开放该API请设置好按API的流量控制。", + "description": "The security authentication method of the API. Valid values:\n\n* **APP: Only authorized applications can call the API.**\n\n* **ANONYMOUS: The API can be anonymously called. In this mode, you must take note of the following rules:**\n\n * All users who have obtained the API service information can call this API. API Gateway does not authenticate callers and cannot set user-specific throttling policies. If you make this API public, set API-specific throttling policies.", "position": "Query", "type": "String", "required": false }, { "name": "BackendName", - "description": "", + "description": "The name of the backend service.", "position": "Query", "type": "String", "required": false }, { "name": "Data", - "description": "", + "description": "The OAS-compliant text file or OSS object URL.", "position": "Body", "type": "String", "required": true }, { "name": "GroupId", - "description": "", + "description": "The ID of the API group.", "position": "Query", "type": "String", "required": true }, { "name": "IgnoreWarning", - "description": "", + "description": "Specifies whether to ignore alerts.", "position": "Query", "type": "Boolean", "required": false }, { "name": "OASVersion", - "description": "", + "description": "The OAS version.", "position": "Query", "type": "String", "required": false }, { "name": "Overwrite", - "description": "", + "description": "Specifies whether to overwrite an existing API.\n\nIf an existing API has the same HTTP request type and backend request path as the API to be imported, the existing API is overwritten.", "position": "Query", "type": "Boolean", "required": true }, { "name": "RequestMode", - "description": "", + "description": "The request mode. Valid values:\n\n* MAPPING: Parameters are mapped. Unknown parameters are filtered out.\n* PASSTHROUGH: Parameters are passed through.", "position": "Query", "type": "String", "required": false @@ -70,7 +70,7 @@ }, { "name": "SkipDryRun", - "description": "", + "description": "Specifies whether to directly import the API without performing a precheck.", "position": "Query", "type": "Boolean", "required": false diff --git a/en-US/cloudapi/ModifyApi.json b/en-US/cloudapi/ModifyApi.json index 8080e2019..cd6125b15 100644 --- a/en-US/cloudapi/ModifyApi.json +++ b/en-US/cloudapi/ModifyApi.json @@ -57,7 +57,7 @@ { "name": "ConstantParameters", "description": "The parameters of API requests sent by API Gateway to the backend service.", - "position": "Query", + "position": "Body", "type": "String", "required": false }, @@ -78,14 +78,14 @@ { "name": "ErrorCodeSamples", "description": "The returned description of the API.", - "position": "Query", + "position": "Body", "type": "String", "required": false }, { "name": "FailResultSample", "description": "The sample error codes returned by the backend service.", - "position": "Query", + "position": "Body", "type": "String", "required": false }, @@ -120,7 +120,7 @@ { "name": "RequestParameters", "description": "System parameter", - "position": "Query", + "position": "Body", "type": "String", "required": false }, @@ -134,14 +134,14 @@ { "name": "ResultDescriptions", "description": "The configuration items of the third-party OpenID Connect authentication method.", - "position": "Query", + "position": "Body", "type": "String", "required": false }, { "name": "ResultSample", "description": "The sample error response from the backend service.", - "position": "Query", + "position": "Body", "type": "String", "required": false }, @@ -169,21 +169,21 @@ { "name": "ServiceParameters", "description": "The mappings between parameters of requests sent by the consumer to API Gateway and parameters of requests sent by API Gateway to the backend service.", - "position": "Query", + "position": "Body", "type": "String", "required": false }, { "name": "ServiceParametersMap", "description": "The format of the response from the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. This value is used only to generate documents. It does not affect the returned results.", - "position": "Query", + "position": "Body", "type": "String", "required": false }, { "name": "SystemParameters", "description": "Constant parameter", - "position": "Query", + "position": "Body", "type": "String", "required": false }, diff --git a/en-US/cloudapi/ModifyInstanceAttribute.json b/en-US/cloudapi/ModifyInstanceAttribute.json new file mode 100644 index 000000000..905a64de9 --- /dev/null +++ b/en-US/cloudapi/ModifyInstanceAttribute.json @@ -0,0 +1,92 @@ +{ + "name": "ModifyInstanceAttribute", + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "DeleteVpcIpBlock", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EgressIpv6Enable", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "HttpsPolicy", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "IPV6Enabled", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "InstanceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "InstanceName", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "IntranetSegments", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "MaintainEndTime", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "MaintainStartTime", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "ToConnectVpcIpBlock", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Token", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "VpcSlbIntranetEnable", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/cloudapi/ModifyInstanceSpec.json b/en-US/cloudapi/ModifyInstanceSpec.json index 89e324c44..88b8c98a2 100644 --- a/en-US/cloudapi/ModifyInstanceSpec.json +++ b/en-US/cloudapi/ModifyInstanceSpec.json @@ -6,42 +6,42 @@ "parameters": [ { "name": "AutoPay", - "description": "", + "description": "Specifies whether payment is automatically made during renewal. Valid values:\n\n* **True**: Automatic payment is enabled. Make sure that your Alibaba Cloud account has adequate balance.\n* **False**: Automatic payment is disabled. You have to manually pay in the console. Log on to the console. In the upper-right corner, choose **Expenses > User Center**. In the left-side navigation pane, click **Orders**. On the page that appears, find your order and complete the payment.\n\nDefault value: **False**.", "position": "Query", "type": "Boolean", "required": false }, { "name": "InstanceId", - "description": "", + "description": "The ID of the instance.", "position": "Query", "type": "String", "required": true }, { "name": "InstanceSpec", - "description": "", + "description": "The specifications of the instance.", "position": "Query", "type": "String", "required": true }, { "name": "ModifyAction", - "description": "", + "description": "Specifies whether to upgrade or downgrade the instance. Valid values:\n\n* **UPGRADE**\n* **DOWNGRADE**\n\nDefault value: **UPGRADE**.", "position": "Query", "type": "String", "required": false }, { "name": "SkipWaitSwitch", - "description": "", + "description": "Specifies whether to skip the Waiting for Traffic Switchover state. During the upgrade or downgrade, a new outbound IP address may be added to the API Gateway instance. The Waiting for Traffic Switchover state is used to remind users of adding the new outbound IP address to the whitelist. If you set the SkipWaitSwitch parameter to true, the instance does not enter the Waiting for Traffic Switchover state when a new outbound IP address is available. Instead, the system sends internal messages to the user.", "position": "Query", "type": "Boolean", "required": false }, { "name": "Token", - "description": "", + "description": "The password.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/SetDomain.json b/en-US/cloudapi/SetDomain.json index d50296127..c9c2612d9 100644 --- a/en-US/cloudapi/SetDomain.json +++ b/en-US/cloudapi/SetDomain.json @@ -6,42 +6,42 @@ "parameters": [ { "name": "BindStageName", - "description": "", + "description": "The environment which you can access by using the domain name. If you do not specify this parameter, the domain name can be used to access all environments.\n\nIf you specify an environment, the domain name can be used to access only the specified environment. Valid values:\n\n* TEST\n* PRE\n* RELEASE\n\nIf you want to use the domain name to access all environments, set this parameter to an empty string (\"\").", "position": "Query", "type": "String", "required": false }, { "name": "CustomDomainType", - "description": "", + "description": "The network type of the domain name to be bound. Default value: INTERNET. Valid values:\n\n* INTERNET\n* INTRANET. If you set this parameter to this value, the domain name cannot be used on the Internet.", "position": "Query", "type": "String", "required": false }, { "name": "DomainName", - "description": "", + "description": "The custom domain name.", "position": "Query", "type": "String", "required": true }, { "name": "GroupId", - "description": "", + "description": "The ID of the API group. This ID is generated by the system and globally unique.", "position": "Query", "type": "String", "required": true }, { "name": "IsForce", - "description": "", + "description": "Specifies whether this binding relationship takes precedence over the binding relationships between the domain name and other API groups. If you set this parameter to true, this binding relationship takes precedence, and the domain name is automatically unbound from other API groups. This operation brings risks. Proceed with caution.", "position": "Query", "type": "Boolean", "required": false }, { "name": "IsHttpRedirectToHttps", - "description": "", + "description": "Specifies whether to redirect HTTP requests to HTTPS requests.", "position": "Query", "type": "Boolean", "required": false diff --git a/en-US/cloudapi/SetDomainWebSocketStatus.json b/en-US/cloudapi/SetDomainWebSocketStatus.json index 3fa901401..f0e6fa663 100644 --- a/en-US/cloudapi/SetDomainWebSocketStatus.json +++ b/en-US/cloudapi/SetDomainWebSocketStatus.json @@ -6,21 +6,21 @@ "parameters": [ { "name": "ActionValue", - "description": "", + "description": "The action.", "position": "Query", "type": "String", "required": true }, { "name": "DomainName", - "description": "", + "description": "The custom domain name.", "position": "Query", "type": "String", "required": true }, { "name": "GroupId", - "description": "", + "description": "The ID of the API group.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudapi/SetVpcAccess.json b/en-US/cloudapi/SetVpcAccess.json index aeb11e88c..b02c1f899 100644 --- a/en-US/cloudapi/SetVpcAccess.json +++ b/en-US/cloudapi/SetVpcAccess.json @@ -6,28 +6,28 @@ "parameters": [ { "name": "Description", - "description": "", + "description": "The description of the VPC.", "position": "Query", "type": "String", "required": false }, { "name": "InstanceId", - "description": "", + "description": "The ID of an ECS or SLB instance in the VPC.", "position": "Query", "type": "String", "required": true }, { "name": "Name", - "description": "", + "description": "The name of the authorization. The name must be unique.", "position": "Query", "type": "String", "required": true }, { "name": "Port", - "description": "", + "description": "The port number that corresponds to the instance.", "position": "Query", "type": "Integer", "required": true @@ -41,7 +41,7 @@ }, { "name": "Tag", - "description": "", + "description": "The tag of objects that match the rule. You can specify multiple tags.", "position": "Query", "type": "RepeatList", "required": false, @@ -62,14 +62,14 @@ }, { "name": "VpcId", - "description": "", + "description": "The ID of the VPC. The VPC must be an available one that belongs to the same account as the API.", "position": "Query", "type": "String", "required": true }, { "name": "VpcTargetHostName", - "description": "", + "description": "The host of the backend service.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudapi/SetWildcardDomainPatterns.json b/en-US/cloudapi/SetWildcardDomainPatterns.json index 71aa2c99e..9c3819b15 100644 --- a/en-US/cloudapi/SetWildcardDomainPatterns.json +++ b/en-US/cloudapi/SetWildcardDomainPatterns.json @@ -6,14 +6,14 @@ "parameters": [ { "name": "DomainName", - "description": "", + "description": "The custom domain name.", "position": "Query", "type": "String", "required": true }, { "name": "GroupId", - "description": "", + "description": "The ID of the API group. This ID is generated by the system and globally unique.", "position": "Query", "type": "String", "required": true @@ -27,7 +27,7 @@ }, { "name": "WildcardDomainPatterns", - "description": "", + "description": "The wildcard domain name mode.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudapi/version.json b/en-US/cloudapi/version.json index 186c0b274..a365e87c8 100644 --- a/en-US/cloudapi/version.json +++ b/en-US/cloudapi/version.json @@ -9,7 +9,7 @@ }, "AddAccessControlListEntry": { "title": "AddAccessControlListEntry", - "summary": "This feature provides instance-level access control capabilities for dedicated instances. Adds an IP address entry to the access control polocy of an instance.", + "summary": "This feature provides instance-level access control capabilities for dedicated instances. Adds an IP address entry to the access control policy of an instance.", "deprecated": false }, "AddIpControlPolicyItem": { @@ -33,7 +33,7 @@ }, "BatchAbolishApis": { "title": "BatchAbolishApis", - "summary": "Unpublishes multiple APIs at a time.", + "summary": "Unpublishes multiple published APIs at a time.", "deprecated": false }, "BatchDeployApis": { @@ -63,7 +63,7 @@ }, "CreateApp": { "title": "CreateApp", - "summary": "Creates an application for calling APIs in API Gateway.", + "summary": "Creates an app for API Gateway.", "deprecated": false }, "CreateBackend": { @@ -108,7 +108,7 @@ }, "CreateMonitorGroup": { "title": "CreateMonitorGroup", - "summary": "Enables CloudMonitor alerting for an API group.", + "summary": "Enables CloudMonitor alerting for a specified API group.", "deprecated": false }, "CreatePlugin": { @@ -138,7 +138,7 @@ }, "DeleteApi": { "title": "DeleteApi", - "summary": "Deletes an API.", + "summary": "Deletes the definition of a specified API.", "deprecated": false }, "DeleteApiGroup": { @@ -157,7 +157,7 @@ }, "DeleteApp": { "title": "DeleteApp", - "summary": "Deletes an application.", + "summary": "Deletes a specified app.", "deprecated": false }, "DeleteBackend": { @@ -182,12 +182,12 @@ }, "DeleteDomain": { "title": "DeleteDomain", - "summary": "Unbinds a custom domain name from a specified API group.", + "summary": "Unbinds a custom domain name from an API group.", "deprecated": false }, "DeleteDomainCertificate": { "title": "DeleteDomainCertificate", - "summary": "Deletes the SSL certificate of a domain name. This operation is intended for API providers. If the SSL certificate does not exist, a success response is still returned. If the specified API group does not exist, the InvalidGroupId.NotFound error is returned. Access over HTTPS is not supported after the SSL certificate is deleted. Exercise caution when using this API operation.", + "summary": "Deletes the SSL certificate of a specified domain name. This operation is intended for API providers. If the SSL certificate does not exist, a success response is still returned. If the specified API group does not exist, the InvalidGroupId.NotFound error is returned. Access over HTTPS is not supported after the SSL certificate is deleted. Exercise caution when using this API operation.", "deprecated": false }, "DeleteInstance": { @@ -237,7 +237,7 @@ }, "DeployApi": { "title": "DeployApi", - "summary": "Publishes an API to an environment.", + "summary": "Publishes an API to a specified environment.", "deprecated": false }, "DescribeAbolishApiTask": { @@ -257,7 +257,7 @@ }, "DescribeApi": { "title": "DescribeApi", - "summary": "Queries the definition of an API.", + "summary": "Queries the definition of a specified API.", "deprecated": false }, "DescribeApiDoc": { @@ -272,7 +272,7 @@ }, "DescribeApiGroupVpcWhitelist": { "title": "DescribeApiGroupVpcWhitelist", - "summary": "Queries the VPCs that are allowed to access an API group.", + "summary": "Queries the VPC whitelist that is allowed to access an API group.", "deprecated": false }, "DescribeApiGroups": { @@ -345,7 +345,7 @@ }, "DescribeApisByBackend": { "title": "DescribeApisByBackend", - "summary": "Queries APIs that use a backend service. The results include APIs in the draft state and published APIs.", + "summary": "Queries APIs in the draft or published state that are created by using a specified backend service.", "deprecated": false }, "DescribeApisByIpControl": { @@ -385,7 +385,7 @@ }, "DescribeApps": { "title": "DescribeApps", - "summary": "Queries the apps. App information is returned only to the app owner.", + "summary": "Queries the apps of a user. App information is returned only to the app owner.", "deprecated": false }, "DescribeAppsByApiProduct": { @@ -399,7 +399,7 @@ }, "DescribeAuthorizedApps": { "title": "DescribeAuthorizedApps", - "summary": "Queries the current apps.", + "summary": "Queries the apps of an API.", "deprecated": false }, "DescribeBackendInfo": { @@ -444,12 +444,12 @@ }, "DescribeDeployedApis": { "title": "DescribeDeployedApis", - "summary": "Queries the APIs that are published to and running in an environment.", + "summary": "Queries the APIs that have been published to a specified environment.", "deprecated": false }, "DescribeDomain": { "title": "DescribeDomain", - "summary": "Queries the details about a bound custom domain name, including the system assigned second-level domain name, custom domain name, and SSL certificate.", + "summary": "Queries details about a bound custom domain name, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.", "deprecated": false }, "DescribeGroupLatency": { @@ -542,12 +542,12 @@ }, "DescribeMarketRemainsQuota": { "title": "DescribeMarketRemainsQuota", - "summary": "Queries the number of remaining order relationships for a purchaser.", + "summary": "Queries the number of remaining ordered relationships for a purchaser.", "deprecated": false }, "DescribeModels": { "title": "DescribeModels", - "summary": "Obtains the created models of an API group.", + "summary": "Queries the created models of an API group.", "deprecated": false }, "DescribePluginApis": { @@ -557,7 +557,7 @@ }, "DescribePluginSchemas": { "title": "DescribePluginSchemas", - "summary": "Queries the plug-in schemas supported by API Gateway.", + "summary": "Describes the plug-in modes supported by API Gateway.", "deprecated": false }, "DescribePluginTemplates": { @@ -567,12 +567,12 @@ }, "DescribePlugins": { "title": "DescribePlugins", - "summary": "Queries API Gateway plug-ins and the details of the plug-ins.", + "summary": "Queries plug-ins and their details.", "deprecated": false }, "DescribePluginsByApi": { "title": "DescribePluginsByApi", - "summary": "Queries the plug-ins that are bound to a running API in an environment.", + "summary": "Queries the plug-ins that are bound to a running API in a specified environment.", "deprecated": false }, "DescribePurchasedApiGroup": { @@ -582,12 +582,12 @@ }, "DescribePurchasedApiGroups": { "title": "DescribePurchasedApiGroups", - "summary": "Queries API groups that are purchased from Alibaba Cloud Marketplace.", + "summary": "Queries the API groups purchased from Alibaba Cloud Marketplace.", "deprecated": false }, "DescribePurchasedApis": { "title": "DescribePurchasedApis", - "summary": "Queries APIs that are purchased from Alibaba Cloud Marketplace.", + "summary": "Queries the APIs purchased in the Alibaba Cloud Marketplace.", "deprecated": false }, "DescribeRegions": { @@ -627,7 +627,7 @@ }, "DescribeUpdateBackendTask": { "title": "DescribeUpdateBackendTask", - "summary": "When you modify the definition of a backend service in an environment, the associated published APIs are updated in batches. This API operation is used to query the update results.", + "summary": "Queries the update results of associated published APIs after the definition of a backend service is modified in an environment.", "deprecated": false }, "DescribeUpdateVpcInfoTask": { @@ -661,7 +661,7 @@ }, "DryRunSwagger": { "title": "DryRunSwagger", - "summary": "Checks the syntax by performing a dry run before Swagger-compliant data is imported.", + "summary": "Checks the syntax before Swagger-compliant data is imported.", "deprecated": false }, "EnableInstanceAccessControl": { @@ -671,17 +671,17 @@ }, "ImportOAS": { "title": "ImportOAS", - "summary": "Imports APIs based on the OAS standard.", + "summary": "Imports OpenAPI Specification (OAS)-compliant data to create an API.", "deprecated": false }, "ImportSwagger": { "title": "ImportSwagger", - "summary": "Creates APIs by importing Swagger-compliant data.", + "summary": "Creates an API by importing Swagger-compliant data.", "deprecated": false }, "ListTagResources": { "title": "ListTagResources", - "summary": "Queries the tags that are added to resources.", + "summary": "Queries the visible resource tags.", "deprecated": false }, "ModifyApi": { @@ -691,7 +691,7 @@ }, "ModifyApiConfiguration": { "title": "ModifyApiConfiguration", - "summary": "Modifies the draft definition of an API. It is different from the ModifyApi operation in that it does not require all information about the API. You need to only specify the parameters that you want to modify. For example, if you want to change the authentication method of the API from Anonymous to APP, you specify APP as the value of AuthType and do not need to configure other parameters.", + "summary": "This API operation is used to modify the draft definition of an API. It is different from the ModifyApi operation in that it does not require all information about the API. You need to only specify the parameters that you want to modify. For example, if you want to change the authentication method of the API from Anonymous to APP, you need to only specify the value of AuthType, which is APP.", "deprecated": false }, "ModifyApiGroup": { @@ -714,7 +714,7 @@ }, "ModifyApp": { "title": "ModifyApp", - "summary": "Modifies a specified application.", + "summary": "Modifies a specified app.", "deprecated": false }, "ModifyBackend": { @@ -737,6 +737,10 @@ "summary": "Modifies the timeout period and description of a data entry in a custom dataset.", "deprecated": false }, + "ModifyInstanceAttribute": { + "title": null, + "deprecated": false + }, "ModifyInstanceSpec": { "title": "ModifyInstanceSpec", "summary": "Upgrades or downgrades the configurations of an API Gateway instance.", @@ -769,7 +773,7 @@ }, "ModifyPlugin": { "title": "ModifyPlugin", - "summary": "Modifies a plug-in.", + "summary": "Modifies the information of a plug-in.", "deprecated": false }, "ModifySignature": { @@ -784,7 +788,7 @@ }, "ModifyVpcAccessAndUpdateApis": { "title": "ModifyVpcAccessAndUpdateApis", - "summary": "Modifies a virtual private cloud (VPC) authorization and updates the metadata of the API associated with the VPC authorization.", + "summary": "Modifies the information of a VPC access authorization and updates the metadata of the associated API.", "deprecated": false }, "OpenApiGatewayService": { @@ -818,7 +822,7 @@ }, "RemoveAppsAuthorities": { "title": "RemoveAppsAuthorities", - "summary": "Revokes the access permissions on a specified API from multiple applications. In this case, multiple applications map to a single API.", + "summary": "Revokes the access permissions on a specified API from multiple apps. In this case, multiple apps map to a single API.", "deprecated": false }, "RemoveIpControlApis": { @@ -843,22 +847,22 @@ }, "RemoveVpcAccess": { "title": "RemoveVpcAccess", - "summary": "Deletes a VPC access authorization without unpublishing associated APIs.", + "summary": "Deletes a VPC access authorization without unpublishing the associated APIs.", "deprecated": false }, "RemoveVpcAccessAndAbolishApis": { "title": "RemoveVpcAccessAndAbolishApis", - "summary": "Deletes a VPC access authorization and unpublishes associated API.", + "summary": "Deletes a VPC access authorization and unpublishes the associated API.", "deprecated": false }, "ResetAppCode": { "title": "ResetAppCode", - "summary": "Resets the AppCode of an app.", + "summary": "Resets the AppCode of an application. You can call this operation only once per minute.", "deprecated": false }, "ResetAppSecret": { "title": "ResetAppSecret", - "summary": "Resets the key of an application.", + "summary": "Resets the key for an app.", "deprecated": false }, "SdkGenerateByApp": { @@ -873,7 +877,7 @@ }, "SdkGenerateByGroup": { "title": "SdkGenerateByGroup", - "summary": "Generates SDKs by API group.", + "summary": "Generates an SDK by API group.", "deprecated": false }, "SetAccessControlListAttribute": { @@ -906,7 +910,7 @@ }, "SetDomainCertificate": { "title": "SetDomainCertificate", - "summary": "Uploads an SSL certificate for a custom domain name.", + "summary": "Uploads an SSL certificate for a specified custom domain name.", "deprecated": false }, "SetDomainWebSocketStatus": { @@ -946,7 +950,7 @@ }, "TagResources": { "title": "TagResources", - "summary": "Creates a tag-resource relationship.", + "summary": "Adds user tags to resources.", "deprecated": false }, "UntagResources": { diff --git a/en-US/cloudfw/CreateNatFirewallControlPolicy.json b/en-US/cloudfw/CreateNatFirewallControlPolicy.json index 64f27724a..0366ffc7f 100644 --- a/en-US/cloudfw/CreateNatFirewallControlPolicy.json +++ b/en-US/cloudfw/CreateNatFirewallControlPolicy.json @@ -77,7 +77,7 @@ }, { "name": "EndTime", - "description": "访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。\n> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。", + "description": "The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of StartTime.\n\n> If RepeatType is set to Permanent, EndTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, this parameter must be specified.", "position": "Query", "type": "Long", "required": false @@ -126,28 +126,28 @@ }, { "name": "RepeatDays", - "description": "访问控制策略的策略有效期的重复日期集合。\n- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。\n 例如：[]\n- 当RepeatType为Weekly时，RepeatDays不能为空。\n 例如：[0, 6]\n> RepeatType设置为Weekly时，RepeatDays不允许重复。\n- 当RepeatType为`Monthly`时，RepeatDays不能为空。\n 例如：[1, 31]\n> RepeatType设置为Monthly时，RepeatDays不允许重复。", + "description": "The days of a week or of a month on which the access control policy takes effect.\n\n* If RepeatType is set to `Permanent`, `None`, or `Daily`, RepeatDays is left empty. Example: \\[].\n* If RepeatType is set to Weekly, RepeatDays must be specified. Example: \\[0, 6].\n\n> If RepeatType is set to Weekly, the fields in the value of RepeatDays cannot be repeated.\n\n* If RepeatType is set to `Monthly`, RepeatDays must be specified. Example: \\[1, 31].\n\n> If RepeatType is set to Monthly, the fields in the value of RepeatDays cannot be repeated.", "position": "Query", "type": "Array", "required": false }, { "name": "RepeatEndTime", - "description": "访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。\n> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。", + "description": "The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of RepeatStartTime.\n\n> If RepeatType is set to Permanent or None, RepeatEndTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.", "position": "Query", "type": "String", "required": false }, { "name": "RepeatStartTime", - "description": "访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。\n> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。", + "description": "The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of RepeatEndTime.\n\n> If RepeatType is set to Permanent or None, RepeatStartTime is left empty. If RepeatType is set to Daily, Weekly, or Monthly, this parameter must be specified.", "position": "Query", "type": "String", "required": false }, { "name": "RepeatType", - "description": "访问控制策略的策略有效期的重复类型。取值：\n- **Permanent**（默认）：总是\n- **None**：指定单次时间\n- **Daily**：每天\n- **Weekly**：每周\n- **Monthly**：每月", + "description": "The recurrence type for the access control policy to take effect. Valid values:\n\n* **Permanent** (default): The policy always takes effect.\n* **None**: The policy takes effect for only once.\n* **Daily**: The policy takes effect on a daily basis.\n* **Weekly**: The policy takes effect on a weekly basis.\n* **Monthly**: The policy takes effect on a monthly basis.", "position": "Query", "type": "String", "required": false @@ -168,7 +168,7 @@ }, { "name": "StartTime", - "description": "访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。\n> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。", + "description": "The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of EndTime.\n\n> If RepeatType is set to Permanent, StartTime is left empty. If RepeatType is set to None, Daily, Weekly, or Monthly, this parameter must be specified.", "position": "Query", "type": "Long", "required": false diff --git a/en-US/cloudfw/DescribeTrFirewallPolicyBackUpAssociationList.json b/en-US/cloudfw/DescribeTrFirewallPolicyBackUpAssociationList.json index f096780e1..1930efe7b 100644 --- a/en-US/cloudfw/DescribeTrFirewallPolicyBackUpAssociationList.json +++ b/en-US/cloudfw/DescribeTrFirewallPolicyBackUpAssociationList.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "FirewallId", - "description": "", + "description": "The instance ID of the VPC firewall.", "position": "Query", "type": "String", "required": false }, { "name": "Lang", - "description": "", + "description": "The language of the content within the response. Valid values:\n\n* **zh** (default): Chinese\n* **en**: English", "position": "Query", "type": "String", "required": false }, { "name": "TrFirewallRoutePolicyId", - "description": "", + "description": "The ID of the routing policy.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudfw/DescribeVpcFirewallControlPolicy.json b/en-US/cloudfw/DescribeVpcFirewallControlPolicy.json index f62546efe..0884c6801 100644 --- a/en-US/cloudfw/DescribeVpcFirewallControlPolicy.json +++ b/en-US/cloudfw/DescribeVpcFirewallControlPolicy.json @@ -70,14 +70,14 @@ }, { "name": "Release", - "description": "Specifies whether the access control policy is enabled. By default, an access control policy is enabled after the policy is created. Valid values:\n\n* **true**: The access control policy is enabled.\n* **false**: The access control policy is disabled.", + "description": "The status of the access control policy. Valid values:\n\n* **true**: enabled\n* **false**: disabled", "position": "Query", "type": "String", "required": false }, { "name": "RepeatType", - "description": "访问控制策略的策略有效期的重复类型。取值：\n- **Permanent**（默认）：总是\n- **None**：指定单次时间\n- **Daily**：每天\n- **Weekly**：每周\n- **Monthly**：每月", + "description": "The recurrence type for the access control policy to take effect. Valid values:\n\n* **Permanent** (default): The policy always takes effect.\n* **None**: The policy takes effect for only once.\n* **Daily**: The policy takes effect on a daily basis.\n* **Weekly**: The policy takes effect on a weekly basis.\n* **Monthly**: The policy takes effect on a monthly basis.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudfw/ModifyFirewallV2RoutePolicySwitch.json b/en-US/cloudfw/ModifyFirewallV2RoutePolicySwitch.json index d498951b4..866cfce9d 100644 --- a/en-US/cloudfw/ModifyFirewallV2RoutePolicySwitch.json +++ b/en-US/cloudfw/ModifyFirewallV2RoutePolicySwitch.json @@ -7,35 +7,35 @@ "parameters": [ { "name": "FirewallId", - "description": "", + "description": "The instance ID of the virtual private cloud (VPC) firewall.", "position": "Query", "type": "String", "required": false }, { "name": "Lang", - "description": "", + "description": "The language of the content within the response. Valid values:\n\n* **zh** (default): Chinese\n* **en**: English", "position": "Query", "type": "String", "required": false }, { "name": "ShouldRecover", - "description": "", + "description": "Specifies whether to restore the traffic redirection configurations. Valid values:\n\n* true: roll back\n* false: withdraw", "position": "Query", "type": "String", "required": false }, { "name": "TrFirewallRoutePolicyId", - "description": "", + "description": "The ID of the routing policy.", "position": "Query", "type": "String", "required": false }, { "name": "TrFirewallRoutePolicySwitchStatus", - "description": "", + "description": "The status of the routing policy. Valid values:\n\n* open: enabled\n* close: disabled", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudfw/ModifyNatFirewallControlPolicyPosition.json b/en-US/cloudfw/ModifyNatFirewallControlPolicyPosition.json index c860538fe..529ca7db2 100644 --- a/en-US/cloudfw/ModifyNatFirewallControlPolicyPosition.json +++ b/en-US/cloudfw/ModifyNatFirewallControlPolicyPosition.json @@ -14,7 +14,7 @@ }, { "name": "Direction", - "description": "", + "description": "The direction of the traffic to which the access control policy applies.\n\n* Set the value to **out**.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudfw/ModifyVpcFirewallControlPolicy.json b/en-US/cloudfw/ModifyVpcFirewallControlPolicy.json index c3c402c56..56e0d3446 100644 --- a/en-US/cloudfw/ModifyVpcFirewallControlPolicy.json +++ b/en-US/cloudfw/ModifyVpcFirewallControlPolicy.json @@ -28,7 +28,7 @@ }, { "name": "ApplicationNameList", - "description": "", + "description": "The application names.", "position": "Query", "type": "RepeatList", "required": false @@ -77,7 +77,7 @@ }, { "name": "EndTime", - "description": "访问控制策略的策略有效期的结束时间。使用秒级时间戳格式表示。必须为整点或半点时间，且大于开始时间至少半小时。\n> 当RepeatType为Permanent时，EndTime为空。当RepeatType为None、Daily、Weekly、Monthly时，EndTime必须有值，您需要设置结束时间。", + "description": "The time when the access control policy stops taking effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of StartTime.\n\n> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.", "position": "Query", "type": "Long", "required": false @@ -105,28 +105,28 @@ }, { "name": "RepeatDays", - "description": "访问控制策略的策略有效期的重复日期集合。\n- 当RepeatType为`Permanent`、`None`、`Daily`时，RepeatDays为空集合。\n 例如：[]\n- 当RepeatType为Weekly时，RepeatDays不能为空。\n 例如：[0, 6]\n> RepeatType设置为Weekly时，RepeatDays不允许重复。\n- 当RepeatType为`Monthly`时，RepeatDays不能为空。\n 例如：[1, 31]\n> RepeatType设置为Monthly时，RepeatDays不允许重复。", + "description": "The days of a week or of a month on which the access control policy takes effect.\n\n* If you set RepeatType to `Permanent`, `None`, or `Daily`, the value of this parameter is an empty array. Example: \\[].\n* If you set RepeatType to Weekly, you must specify this parameter. Example: \\[0, 6].\n\n> If you set RepeatType to Weekly, the fields in the value of this parameter cannot be repeated.\n\n* If you set RepeatType to `Monthly`, you must specify this parameter. Example: \\[1, 31].\n\n> If you set RepeatType to Monthly, the fields in the value of this parameter cannot be repeated.", "position": "Query", "type": "Array", "required": false }, { "name": "RepeatEndTime", - "description": "访问控制策略的策略有效期的重复结束时间。例如：23:30，必须为整点或半点时间，且大于重复开始时间至少半小时。\n> 当RepeatType为Permanent、None时，RepeatEndTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatEndTime必须有值，您需要设置重复结束时间。", + "description": "The point in time when the recurrence ends. Example: 23:30. The value must be on the hour or on the half hour, and at least 30 minutes later than the value of RepeatStartTime.\n\n> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.", "position": "Query", "type": "String", "required": false }, { "name": "RepeatStartTime", - "description": "访问控制策略的策略有效期的重复开始时间。例如：08:00，必须为整点或半点时间，且小于重复结束时间至少半小时。\n> 当RepeatType为Permanent、None时，RepeatStartTime为空。当RepeatType为Daily、Weekly、Monthly时，RepeatStartTime必须有值，您需要设置重复开始时间。", + "description": "The point in time when the recurrence starts. Example: 08:00. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of RepeatEndTime.\n\n> If you set RepeatType to Permanent or None, leave this parameter empty. If you set RepeatType to Daily, Weekly, or Monthly, you must specify this parameter.", "position": "Query", "type": "String", "required": false }, { "name": "RepeatType", - "description": "访问控制策略的策略有效期的重复类型。取值：\n- **Permanent**（默认）：总是\n- **None**：指定单次时间\n- **Daily**：每天\n- **Weekly**：每周\n- **Monthly**：每月", + "description": "The recurrence type for the access control policy to take effect. Valid values:\n\n* **Permanent** (default): The policy always takes effect.\n* **None**: The policy takes effect for only once.\n* **Daily**: The policy takes effect on a daily basis.\n* **Weekly**: The policy takes effect on a weekly basis.\n* **Monthly**: The policy takes effect on a monthly basis.", "position": "Query", "type": "String", "required": false @@ -147,7 +147,7 @@ }, { "name": "StartTime", - "description": "访问控制策略的策略有效期的开始时间。使用秒级时间戳格式表示。必须为整点或半点时间，且小于结束时间至少半小时。\n> 当RepeatType为Permanent时，StartTime为空。当RepeatType为None、Daily、Weekly、Monthly时，StartTime必须有值，您需要设置开始时间。", + "description": "The time when the access control policy starts to take effect. The value is a UNIX timestamp. Unit: seconds. The value must be on the hour or on the half hour, and at least 30 minutes earlier than the value of EndTime.\n\n> If you set RepeatType to Permanent, leave this parameter empty. If you set RepeatType to None, Daily, Weekly, or Monthly, you must specify this parameter.", "position": "Query", "type": "Long", "required": false diff --git a/en-US/cloudfw/ReleasePostInstance.json b/en-US/cloudfw/ReleasePostInstance.json new file mode 100644 index 000000000..e92cc147b --- /dev/null +++ b/en-US/cloudfw/ReleasePostInstance.json @@ -0,0 +1,16 @@ +{ + "name": "ReleasePostInstance", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "POST", + "pathPattern": "", + "parameters": [ + { + "name": "InstanceId", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/cloudfw/version.json b/en-US/cloudfw/version.json index 499b9f926..f9fee9035 100644 --- a/en-US/cloudfw/version.json +++ b/en-US/cloudfw/version.json @@ -4,7 +4,7 @@ "apis": { "AddAddressBook": { "title": "AddAddressBook", - "summary": "Adds the security access control address book, such as the IP address book, ECS tag address book, port address book, or domain name address book.", + "summary": "Creates an address book for access control. Supported address book types are IP address books, Elastic Compute Service (ECS) tag-based address books, port address books, and domain address books. An ECS tag-based address book includes the public IP addresses of the ECS instances that have specific tags.", "deprecated": false }, "AddControlPolicy": { @@ -24,7 +24,7 @@ }, "CreateNatFirewallControlPolicy": { "title": "CreateNatFirewallControlPolicy", - "summary": "Creates an access control policy of the NAT firewall.", + "summary": "Creates an access control policy for a NAT firewall.", "deprecated": false }, "CreateTrFirewallV2": { @@ -33,8 +33,8 @@ "deprecated": false }, "CreateTrFirewallV2RoutePolicy": { - "title": null, - "summary": null, + "title": "CreateTrFirewallV2RoutePolicy", + "summary": "", "deprecated": false }, "CreateVpcFirewallCenConfigure": { @@ -44,12 +44,12 @@ }, "CreateVpcFirewallConfigure": { "title": "CreateVpcFirewallConfigure", - "summary": "Creates a Virtual Private Cloud (VPC) firewall to protect traffic between two VPCs that are connected by using a Express Connect.", + "summary": "Creates a Virtual Private Cloud (VPC) firewall to protect traffic between two VPCs that are connected by using an Express Connect.", "deprecated": false }, "CreateVpcFirewallControlPolicy": { "title": "CreateVpcFirewallControlPolicy", - "summary": "Creates an access control policy in a policy group for a virtual private cloud (VPC) firewall.", + "summary": "Creates an access control policy in a specified policy group for a virtual private cloud (VPC) firewall.", "deprecated": false }, "DeleteAddressBook": { @@ -63,8 +63,8 @@ "deprecated": false }, "DeleteFirewallV2RoutePolicies": { - "title": null, - "summary": null, + "title": "DeleteFirewallV2RoutePolicies", + "summary": "", "deprecated": false }, "DeleteInstanceMembers": { @@ -134,7 +134,7 @@ }, "DescribeInternetTrafficTrend": { "title": "DescribeInternetTrafficTrend", - "summary": "", + "summary": "Queries the trends of Internet traffic.", "deprecated": false }, "DescribeInvadeEventList": { @@ -183,8 +183,8 @@ "deprecated": false }, "DescribeTrFirewallPolicyBackUpAssociationList": { - "title": null, - "summary": null, + "title": "DescribeTrFirewallPolicyBackUpAssociationList", + "summary": "Queries information about the transit routers that are associated with a virtual private cloud (VPC) firewall created for a transit router.", "deprecated": false }, "DescribeTrFirewallV2RoutePolicyList": { @@ -203,8 +203,8 @@ "deprecated": false }, "DescribeTrFirewallsV2RouteList": { - "title": null, - "summary": null, + "title": "DescribeTrFirewallsV2RouteList", + "summary": "", "deprecated": false }, "DescribeUserAssetIPTrafficInfo": { @@ -273,8 +273,8 @@ "deprecated": false }, "ModifyFirewallV2RoutePolicySwitch": { - "title": null, - "summary": null, + "title": "ModifyFirewallV2RoutePolicySwitch", + "summary": "Modifies the status of a routing policy.", "deprecated": false }, "ModifyInstanceMemberAttributes": { @@ -298,13 +298,13 @@ "deprecated": false }, "ModifyTrFirewallV2Configuration": { - "title": null, - "summary": null, + "title": "ModifyTrFirewallV2Configuration", + "summary": "", "deprecated": false }, "ModifyTrFirewallV2RoutePolicyScope": { - "title": null, - "summary": null, + "title": "ModifyTrFirewallV2RoutePolicyScope", + "summary": "", "deprecated": false }, "ModifyVpcFirewallCenConfigure": { @@ -362,6 +362,11 @@ "summary": "Enables firewalls for specific assets.", "deprecated": false }, + "ReleasePostInstance": { + "title": null, + "summary": null, + "deprecated": false + }, "ResetVpcFirewallRuleHitCount": { "title": "ResetVpcFirewallRuleHitCount", "summary": "Clears the count on hits of an access control policy that is created for a virtual private cloud (VPC) firewall in a specific policy group.", diff --git a/en-US/cloudsso/CreateAccessAssignment.json b/en-US/cloudsso/CreateAccessAssignment.json index 737e079c8..b4a0ca3bc 100644 --- a/en-US/cloudsso/CreateAccessAssignment.json +++ b/en-US/cloudsso/CreateAccessAssignment.json @@ -42,7 +42,7 @@ }, { "name": "TargetType", - "description": "The type of the task object. Set the value to RD-Account, which indicates an account in your resource directory.", + "description": "The type of the task object. Set the value to RD-Account, which specifies the accounts in the resource directory.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudsso/DeleteAccessAssignment.json b/en-US/cloudsso/DeleteAccessAssignment.json index b1df6a969..47533429f 100644 --- a/en-US/cloudsso/DeleteAccessAssignment.json +++ b/en-US/cloudsso/DeleteAccessAssignment.json @@ -49,7 +49,7 @@ }, { "name": "TargetType", - "description": "The type of the task object. The value is fixed as RD-Account, which indicates the accounts in the resource directory.", + "description": "The type of the task object. Set the value to RD-Account, which specifies the accounts in the resource directory.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudsso/DeprovisionAccessConfiguration.json b/en-US/cloudsso/DeprovisionAccessConfiguration.json index e6fa7248b..98af8f71b 100644 --- a/en-US/cloudsso/DeprovisionAccessConfiguration.json +++ b/en-US/cloudsso/DeprovisionAccessConfiguration.json @@ -14,7 +14,7 @@ }, { "name": "DirectoryId", - "description": "The ID of the directory.", + "description": "The directory ID.", "position": "Query", "type": "String", "required": true @@ -28,7 +28,7 @@ }, { "name": "TargetType", - "description": "The type of the task object. Set the value to RD-Account, which indicates an account in your resource directory.", + "description": "The type of the task object. Set the value to RD-Account, which specifies the accounts in the resource directory.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudsso/GetTask.json b/en-US/cloudsso/GetTask.json index 6eb03f55e..cf0714b70 100644 --- a/en-US/cloudsso/GetTask.json +++ b/en-US/cloudsso/GetTask.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "DirectoryId", - "description": "The ID of the directory.", + "description": "The directory ID.", "position": "Query", "type": "String", "required": true }, { "name": "TaskId", - "description": "The ID of the task.", + "description": "The task ID.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudsso/GetTaskStatus.json b/en-US/cloudsso/GetTaskStatus.json index 5d2df9526..b78a5a3a2 100644 --- a/en-US/cloudsso/GetTaskStatus.json +++ b/en-US/cloudsso/GetTaskStatus.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "DirectoryId", - "description": "The ID of the directory.", + "description": "The directory ID.", "position": "Query", "type": "String", "required": true }, { "name": "TaskId", - "description": "The ID of the task.", + "description": "The task ID.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudsso/ListAccessAssignments.json b/en-US/cloudsso/ListAccessAssignments.json index 05cb8eb8e..98812c491 100644 --- a/en-US/cloudsso/ListAccessAssignments.json +++ b/en-US/cloudsso/ListAccessAssignments.json @@ -14,49 +14,49 @@ }, { "name": "DirectoryId", - "description": "The ID of the directory.", + "description": "The directory ID.", "position": "Query", "type": "String", "required": true }, { "name": "MaxResults", - "description": "The number of entries to return on each page.\n\nValid values: 1 to 20.\n\nDefault value: 10.", + "description": "The maximum number of entries per page.\n\nValid values: 1 to 20.\n\nDefault value: 10.", "position": "Query", "type": "Integer", "required": false }, { "name": "NextToken", - "description": "The token to return for the next page. If this is your first time to call this operation, you do not need to specify `NextToken`.\n\nWhen you call this operation for the first time, if the total number of entries to return exceeds the value of `MaxResults`, the entries are truncated. Only the entries that match the value of `MaxResults` are returned, and the excess entries are not returned. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.", + "description": "The pagination token that is used in the next request to retrieve a new page of results. If this is your first time to call this operation, you do not need to specify the `NextToken` parameter.\n\nWhen you call this operation for the first time, if the total number of entries to return exceeds the value of `MaxResults`, the entries are truncated. Only the entries that match the value of `MaxResults` are returned, and the excess entries are not returned. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.", "position": "Query", "type": "String", "required": false }, { "name": "PrincipalId", - "description": "The ID of the CloudSSO identity. The ID can be used to filter access permissions.\n\n* If you set `PrincipalType` to User, set `PrincipalId` to the ID of the Cloud SSO user.\n* If you set `PrincipalType` to Group, set `PrincipalId` to the ID of the CloudSSO group.\n\n> You can use the ID to filter access permissions only if you specify both `PrincipalId` and `PrincipalType`.", + "description": "The ID of the CloudSSO identity. The ID can be used to filter access permissions.\n\n* If you set `PrincipalType` to User, set `PrincipalId` to the ID of the CloudSSO user.\n* If you set `PrincipalType` to Group, set `PrincipalId` to the ID of the CloudSSO group.\n\n> You can use the type to filter access permissions only if you specify both PrincipalId and `PrincipalType`.``", "position": "Query", "type": "String", "required": false }, { "name": "PrincipalType", - "description": "The type of the CloudSSO identity. The type can be used to filter access permissions. Valid values:\n\n* User\n* Group\n\n> You can use the type to filter access permissions only if you specify both `PrincipalId` and `PrincipalType`.", + "description": "The type of the CloudSSO identity. The type can be used to filter access permissions. Valid values:\n\n* User\n* Group\n\n> You can use the type to filter access permissions only if you specify both PrincipalId and `PrincipalType`.``", "position": "Query", "type": "String", "required": false }, { "name": "TargetId", - "description": "The ID of the task object. The ID can be used to filter access permissions.\n\n> You can use the ID to filter access permissions only if you specify both `TargetId` and `TargetType`.", + "description": "The ID of the task object. The ID can be used to filter access permissions.\n\n> You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.", "position": "Query", "type": "String", "required": false }, { "name": "TargetType", - "description": "The type of the task object. The type can be used to filter access permissions.\n\nSet the value to RD-Account, which indicates an account in your resource directory.\n\n> You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.", + "description": "The type of the task object. The type can be used to filter access permissions.\n\nSet the value to RD-Account, which specifies the accounts in the resource directory.\n\n> You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudsso/ListAccessConfigurationProvisionings.json b/en-US/cloudsso/ListAccessConfigurationProvisionings.json index 951346417..c45749e51 100644 --- a/en-US/cloudsso/ListAccessConfigurationProvisionings.json +++ b/en-US/cloudsso/ListAccessConfigurationProvisionings.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "AccessConfigurationId", - "description": "The ID of the access configuration. The ID can be used to filter accounts.", + "description": "The ID of the access configuration. The ID can be used to filter access permissions.", "position": "Query", "type": "String", "required": false @@ -21,14 +21,14 @@ }, { "name": "MaxResults", - "description": "The number of entries to return on each page.\n\nValid values: 1 to 20.\n\nDefault value: 10.", + "description": "The maximum number of entries per page.\n\nValid values: 1 to 20.\n\nDefault value: 10.", "position": "Query", "type": "Integer", "required": false }, { "name": "NextToken", - "description": "The token to return for the next page. If this is your first time to call this operation, you do not need to specify `NextToken`.\n\nWhen you call this operation for the first time, if the total number of entries to return exceeds the value of `MaxResults`, the entries are truncated. Only the entries that match the value of `MaxResults` are returned, and the excess entries are not returned. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.", + "description": "The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. If this is your first time to call this operation, you do not need to specify the `NextToken` parameter.\n\nWhen you call this operation for the first time, if the total number of entries to return exceeds the value of `MaxResults`, the entries are truncated. Only the entries that match the value of `MaxResults` are returned, and the excess entries are not returned. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.", "position": "Query", "type": "String", "required": false @@ -42,14 +42,14 @@ }, { "name": "TargetId", - "description": "The ID of the task object. The ID can be used to filter accounts.\n\n> You can use the ID to filter accounts only if you specify both `TargetId` and `TargetType`.", + "description": "The ID of the task object. The ID can be used to filter access permissions.\n\n> You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.", "position": "Query", "type": "String", "required": false }, { "name": "TargetType", - "description": "The type of the task object. The type can be used to filter accounts.\n\nSet the value to RD-Account, which indicates an account in your resource directory.\n\n> You can use the type to filter accounts only if you specify both `TargetId` and `TargetType`.", + "description": "The type of the task object. The type can be used to filter access permissions.\n\nSet the value to RD-Account, which specifies the accounts in the resource directory.\n\n> You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudsso/ListTasks.json b/en-US/cloudsso/ListTasks.json index 57c2d7da0..d1e0655aa 100644 --- a/en-US/cloudsso/ListTasks.json +++ b/en-US/cloudsso/ListTasks.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "AccessConfigurationId", - "description": "The ID of the access configuration. The ID can be used to filter asynchronous tasks.", + "description": "The ID of the access configuration. The ID can be used to filter access permissions.", "position": "Query", "type": "String", "required": false @@ -21,63 +21,63 @@ }, { "name": "Filter", - "description": "The filter condition.\n\nSpecify the value in the \\ \\ \\ format. The value is not case sensitive. You can set Attribute only to StartTime and Operator only to ge. You must set Value in the YYYY-MM-DDTHH:mm:SSZ format and enter a value that is no more than 7 days from the current time. The value ge indicates Greater Than or Equals.\n\nFor example, if you set Filter to StartTime ge 2021-03-15T01:12:23Z, the operation queries the tasks from 2021-03-15T01:12:23 GMT.\n\n> If you do not specify this parameter, the operation queries the tasks within the previous 24 hours by default.", + "description": "The filter condition.\n\nThe condition is not case-sensitive. The condition must be in the StartTime ge YYYY-MM-DDTHH:mm:SSZ format. You must set YYYY-MM-DDTHH:mm:SSZ to a value that is no more than 7 days from the current time. ge indicates Greater Than or Equals.\n\nFor example, if you set the Filter parameter to StartTime ge 2021-03-15T01:12:23Z, the operation queries the tasks from 2021-03-15T01:12:23 GMT.\n\n> If you do not specify this parameter, the operation queries the tasks within the previous 24 hours by default.", "position": "Query", "type": "String", "required": false }, { "name": "MaxResults", - "description": "The number of entries to return on each page.\n\nValid values: 1 to 20.\n\nDefault value: 10.", + "description": "The maximum number of entries per page.\n\nValid values: 1 to 20.\n\nDefault value: 10.", "position": "Query", "type": "Integer", "required": false }, { "name": "NextToken", - "description": "The token to return for the next page. If this is your first time to call this operation, you do not need to specify `NextToken`.\n\nWhen you call this operation for the first time, if the total number of entries to return exceeds the value of `MaxResults`, the entries are truncated. Only the entries that match the value of `MaxResults` are returned, and the excess entries are not returned. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.", + "description": "The pagination token that is used in the next request to retrieve a new page of results. If this is your first time to call this operation, you do not need to specify the `NextToken` parameter.\n\nWhen you call this operation for the first time, if the total number of entries to return exceeds the value of `MaxResults`, the entries are truncated. Only the entries that match the value of `MaxResults` are returned, and the excess entries are not returned. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.", "position": "Query", "type": "String", "required": false }, { "name": "PrincipalId", - "description": "The ID of the CloudSSO identity. The ID can be used to filter asynchronous tasks.\n\n* If you set `PrincipalType` to `User`, set `PrincipalId` to the ID of the CloudSSO user.\n* If you set `PrincipalType` to `Group`, set `PrincipalId` to the ID of the CloudSSO group.\n\n> You can use the ID to filter asynchronous tasks only if you specify both `PrincipalId` and `PrincipalType`.", + "description": "The ID of the CloudSSO identity. The ID can be used to filter access permissions.\n\n* If you set `PrincipalType` to `User`, set `PrincipalId` to the ID of the CloudSSO user.\n* If you set `PrincipalType` to `Group`, set `PrincipalId` to the ID of the CloudSSO group.\n\n> You can use the type to filter access permissions only if you specify both `PrincipalId` and `PrincipalType`.", "position": "Query", "type": "String", "required": false }, { "name": "PrincipalType", - "description": "The type of the CloudSSO identity. The type can be used to filter asynchronous tasks. Valid values:\n\n* User\n* Group\n\n> You can use the type to filter asynchronous tasks only if you specify both `PrincipalId` and `PrincipalType`.", + "description": "The type of the CloudSSO identity. The type can be used to filter access permissions. Valid values:\n\n* User\n* Group\n\n> You can use the type to filter access permissions only if you specify both `PrincipalId` and `PrincipalType`.", "position": "Query", "type": "String", "required": false }, { "name": "Status", - "description": "The ID of the task. The ID can be used to filter asynchronous tasks. Valid values:\n\n* InProgress: The task is running.\n* Success: The task is successful.\n* Failed: The task failed.", + "description": "The ID of the task. The ID can be used to filter tasks. Valid values:\n\n* InProgress: The task is running.\n* Success: The task is successful.\n* Failed: The task failed.", "position": "Query", "type": "String", "required": false }, { "name": "TargetId", - "description": "The ID of the task object. The ID can be used to filter asynchronous tasks.\n\n> You can use the ID to filter asynchronous tasks only if you specify both `TargetId` and `TargetType`.", + "description": "The ID of the task object. The ID can be used to filter access permissions.\n\n> You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.", "position": "Query", "type": "String", "required": false }, { "name": "TargetType", - "description": "The type of the task object. The type can be used to filter asynchronous tasks.\n\nSet the value to RD-Account, which indicates an account in your resource directory.\n\n> You can use the type to filter asynchronous tasks only if you specify both `TargetId` and `TargetType`.", + "description": "The type of the task object. The type can be used to filter access permissions.\n\nSet the value to RD-Account, which specifies the accounts in the resource directory.\n\n> You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.", "position": "Query", "type": "String", "required": false }, { "name": "TaskType", - "description": "The type of the task. The type can be used to filter asynchronous tasks. Valid values:\n\n* ProvisionAccessConfiguration: An access configuration is provisioned.\n* DeprovisionAccessConfiguration: An access configuration is de-provisioned.\n* CreateAccessAssignment: Access permissions on an account in your resource directory are assigned.\n* DeleteAccessAssignment: Access permissions on an account in your resource directory are removed.", + "description": "The type of the task. The type can be used to filter tasks. Valid values:\n\n* ProvisionAccessConfiguration: An access configuration is provisioned.\n* DeprovisionAccessConfiguration: An access configuration is de-provisioned.\n* CreateAccessAssignment: Access permissions on an account in the resource directory are assigned.\n* DeleteAccessAssignment: Access permissions on an account in the resource directory are removed.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cloudsso/ProvisionAccessConfiguration.json b/en-US/cloudsso/ProvisionAccessConfiguration.json index 15a147f38..f5d2763ff 100644 --- a/en-US/cloudsso/ProvisionAccessConfiguration.json +++ b/en-US/cloudsso/ProvisionAccessConfiguration.json @@ -14,7 +14,7 @@ }, { "name": "DirectoryId", - "description": "The ID of the directory.", + "description": "The directory ID.", "position": "Query", "type": "String", "required": true @@ -28,7 +28,7 @@ }, { "name": "TargetType", - "description": "The type of the task object. Set the value to RD-Account, which indicates an account in your resource directory.", + "description": "The type of the task object. Set the value to RD-Account, which specifies the accounts in the resource directory.", "position": "Query", "type": "String", "required": true diff --git a/en-US/cloudsso/version.json b/en-US/cloudsso/version.json index 708fff380..ba0c6a5e8 100644 --- a/en-US/cloudsso/version.json +++ b/en-US/cloudsso/version.json @@ -59,7 +59,7 @@ }, "DeleteAccessAssignment": { "title": "DeleteAccessAssignment", - "summary": "Remove the access permissions on an account in a resource directory.", + "summary": "Removes the access permissions on an account in a resource directory.", "deprecated": false }, "DeleteAccessConfiguration": { @@ -224,7 +224,7 @@ }, "ListAccessConfigurationProvisionings": { "title": "ListAccessConfigurationProvisionings", - "summary": "Queries the accounts for which access permissions are provisioned.", + "summary": "Queries the access configurations that are provisioned.", "deprecated": false }, "ListAccessConfigurations": { diff --git a/en-US/cms/DescribeAlertLogCount.json b/en-US/cms/DescribeAlertLogCount.json index 5c4992cbf..dd66a1e5c 100644 --- a/en-US/cms/DescribeAlertLogCount.json +++ b/en-US/cms/DescribeAlertLogCount.json @@ -20,7 +20,7 @@ }, { "name": "EventType", - "description": "", + "description": "The type of the alert event. Valid values:\n\n* TRIGGERED: The alert is triggered.\n* RESOLVED: The alert is resolved.", "position": "Query", "type": "String", "required": false @@ -90,7 +90,7 @@ }, { "name": "RuleId", - "description": "", + "description": "The ID of the alert rule.\n\nFor more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).", "position": "Query", "type": "String", "required": false diff --git a/en-US/cms/DescribeAlertLogHistogram.json b/en-US/cms/DescribeAlertLogHistogram.json index 359d1454a..3a4f11f6d 100644 --- a/en-US/cms/DescribeAlertLogHistogram.json +++ b/en-US/cms/DescribeAlertLogHistogram.json @@ -20,7 +20,7 @@ }, { "name": "EventType", - "description": "", + "description": "The type of the alert event. Valid values:\n\n* TRIGGERED: The alert is triggered.\n* RESOLVED: The alert is resolved.", "position": "Query", "type": "String", "required": false @@ -90,7 +90,7 @@ }, { "name": "RuleId", - "description": "", + "description": "The ID of the alert rule.\n\nFor more information about how to obtain the ID of an alert rule, see [DescribeMetricRuleList](~~114941~~).", "position": "Query", "type": "String", "required": false diff --git a/en-US/cms/DescribeAlertLogList.json b/en-US/cms/DescribeAlertLogList.json index da8498145..4b15dd20d 100644 --- a/en-US/cms/DescribeAlertLogList.json +++ b/en-US/cms/DescribeAlertLogList.json @@ -20,7 +20,7 @@ }, { "name": "EventType", - "description": "", + "description": "The type of the alert event. Valid values:\n\n* TRIGGERED: The alert is triggered.\n* RESOLVED: The alert is resolved.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cms/version.json b/en-US/cms/version.json index 840891063..bbe044349 100644 --- a/en-US/cms/version.json +++ b/en-US/cms/version.json @@ -14,7 +14,7 @@ }, "BatchCreateInstantSiteMonitor": { "title": "BatchCreateInstantSiteMonitor", - "summary": "", + "summary": "Creates site monitoring tasks.", "deprecated": false }, "BatchCreateIntantSiteMonitor": { @@ -809,7 +809,7 @@ }, "PutMonitoringConfig": { "title": "PutMonitoringConfig", - "summary": "", + "summary": "Configures global settings for the CloudMonitor agent.", "deprecated": false }, "PutResourceMetricRule": { diff --git a/en-US/computenestsupplier/AddServiceSharedAccounts.json b/en-US/computenestsupplier/AddServiceSharedAccounts.json new file mode 100644 index 000000000..0dec7c3ed --- /dev/null +++ b/en-US/computenestsupplier/AddServiceSharedAccounts.json @@ -0,0 +1,58 @@ +{ + "name": "AddServiceSharedAccounts", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "ClientToken", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "RegionId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "ServiceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "SharedAccounts", + "description": "", + "position": "Query", + "type": "RepeatList", + "required": true, + "sub_parameters": [ + { + "name": "Permission", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "UserAliUid", + "position": "Query", + "type": "String", + "required": true + } + ] + }, + { + "name": "Type", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/computenestsupplier/UpgradeServiceInstance.json b/en-US/computenestsupplier/UpgradeServiceInstance.json index a98dd15e4..d8a8cbc0e 100644 --- a/en-US/computenestsupplier/UpgradeServiceInstance.json +++ b/en-US/computenestsupplier/UpgradeServiceInstance.json @@ -19,6 +19,13 @@ "type": "String", "required": false }, + { + "name": "Parameters", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "RegionId", "description": "", diff --git a/en-US/computenestsupplier/version.json b/en-US/computenestsupplier/version.json index 43fa0ef59..8d6cad239 100644 --- a/en-US/computenestsupplier/version.json +++ b/en-US/computenestsupplier/version.json @@ -2,6 +2,11 @@ "version": "2021-05-21", "style": "rpc", "apis": { + "AddServiceSharedAccounts": { + "title": null, + "summary": null, + "deprecated": false + }, "ContinueDeployServiceInstance": { "title": null, "summary": null, diff --git a/en-US/cr/ListEventCenterRecord.json b/en-US/cr/ListEventCenterRecord.json index 079771a25..b13b98c86 100644 --- a/en-US/cr/ListEventCenterRecord.json +++ b/en-US/cr/ListEventCenterRecord.json @@ -33,6 +33,20 @@ "type": "Integer", "required": false }, + { + "name": "RepoName", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "RepoNamespaceName", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "RuleId", "description": "The ID of the event notification rule.", diff --git a/en-US/cr/ListInstanceEndpoint.json b/en-US/cr/ListInstanceEndpoint.json index 25e5a766b..51f44732e 100644 --- a/en-US/cr/ListInstanceEndpoint.json +++ b/en-US/cr/ListInstanceEndpoint.json @@ -17,6 +17,13 @@ "position": "Query", "type": "String", "required": false + }, + { + "name": "Summary", + "description": "", + "position": "Query", + "type": "Boolean", + "required": false } ] } \ No newline at end of file diff --git a/en-US/cr/version.json b/en-US/cr/version.json index f5befbc45..5ee67832d 100644 --- a/en-US/cr/version.json +++ b/en-US/cr/version.json @@ -139,7 +139,7 @@ }, "DeleteInstanceVpcEndpointLinkedVpc": { "title": "DeleteInstanceVpcEndpointLinkedVpc", - "summary": "Disassociates a virtual private cloud (VPC) from a Container Registry instance.", + "summary": "Disassociates a virtual private cloud (VPC) from an instance.", "deprecated": false }, "DeleteNamespace": { @@ -209,7 +209,7 @@ }, "GetInstanceCount": { "title": "GetInstanceCount", - "summary": "", + "summary": "Queries the number of instances.", "deprecated": false }, "GetInstanceEndpoint": { @@ -264,17 +264,17 @@ }, "GetRepoTagManifest": { "title": "GetRepoTagManifest", - "summary": "Queries the manifest information about an image tag.", + "summary": "Queries the manifest information of an image tag.", "deprecated": false }, "GetRepoTagScanStatus": { - "title": "", - "summary": "", + "title": "GetRepoTagScanStatus", + "summary": "Queries the scanning status of an image tag.", "deprecated": false }, "GetRepoTagScanSummary": { "title": "GetRepoTagScanSummary", - "summary": "", + "summary": "Queries the number of vulnerabilities for each severity level. These vulnerabilities are detected in a security scan that is created for an image version.", "deprecated": false }, "GetRepository": { @@ -388,8 +388,8 @@ "deprecated": false }, "ListTagResources": { - "title": null, - "summary": null, + "title": "ListTagResources", + "summary": "Queries the tags that are added to a specified cloud resource.", "deprecated": false }, "ResetLoginPassword": { @@ -398,13 +398,13 @@ "deprecated": false }, "TagResources": { - "title": null, - "summary": null, + "title": "TagResources", + "summary": "Adds tags to a resource.", "deprecated": false }, "UntagResources": { - "title": null, - "summary": null, + "title": "UntagResources", + "summary": "Removes tags from resources.", "deprecated": false }, "UpdateChain": { @@ -419,7 +419,7 @@ }, "UpdateChartRepository": { "title": "UpdateChartRepository", - "summary": "Updates a chart repository.", + "summary": "Updates a chart repository of a Container Registry instance.", "deprecated": false }, "UpdateEventCenterRule": { @@ -429,7 +429,7 @@ }, "UpdateInstanceEndpointStatus": { "title": "UpdateInstanceEndpointStatus", - "summary": "Updates the status of an endpoint of an instance.", + "summary": "Updates the status of an instance endpoint.", "deprecated": false }, "UpdateNamespace": { @@ -449,7 +449,7 @@ }, "UpdateRepoTrigger": { "title": "UpdateRepoTrigger", - "summary": "Updates a trigger for an image repository.", + "summary": "Updates a trigger of an image repository.", "deprecated": false }, "UpdateRepository": { diff --git a/en-US/cs/CancelClusterUpgrade.json b/en-US/cs/CancelClusterUpgrade.json index f8fae9c47..edaea786a 100644 --- a/en-US/cs/CancelClusterUpgrade.json +++ b/en-US/cs/CancelClusterUpgrade.json @@ -1,6 +1,6 @@ { "name": "CancelClusterUpgrade", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "POST", "pathPattern": "/api/v2/clusters/[ClusterId]/upgrade/cancel", diff --git a/en-US/cs/DescribeAddons.json b/en-US/cs/DescribeAddons.json index e9654d7e5..6a84aba5d 100644 --- a/en-US/cs/DescribeAddons.json +++ b/en-US/cs/DescribeAddons.json @@ -1,6 +1,6 @@ { "name": "DescribeAddons", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "GET", "pathPattern": "/clusters/components/metadata", @@ -21,7 +21,7 @@ }, { "name": "cluster_type", - "description": "The type of cluster. Valid values:\n\n* `Kubernetes`: ACK dedicated cluster\n* `ManagedKubernetes`: ACK managed cluster\n* `Ask`: ACK Serverless cluster\n* `ExternalKubernetes`: registered cluster", + "description": "The type of cluster. Valid values:\n\n* `Kubernetes`: ACK dedicated cluster.\n* `ManagedKubernetes`: ACK managed cluster. ACK managed clusters include ACK Pro clusters, ACK Basic clusters, ACK Serverless Pro clusters, ACK Serverless Basic clusters, ACK Edge Pro clusters, and ACK Edge Basic clusters.\n* `ExternalKubernetes`: registered cluster.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cs/DescribeClusterAddonInstance.json b/en-US/cs/DescribeClusterAddonInstance.json index 1dd1b24c0..7962c9534 100644 --- a/en-US/cs/DescribeClusterAddonInstance.json +++ b/en-US/cs/DescribeClusterAddonInstance.json @@ -1,6 +1,6 @@ { "name": "DescribeClusterAddonInstance", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "GET", "pathPattern": "/clusters/[ClusterID]/components/[AddonName]/instance", diff --git a/en-US/cs/DescribeClusterAddonMetadata.json b/en-US/cs/DescribeClusterAddonMetadata.json index 6a1eec80d..3ed2476bb 100644 --- a/en-US/cs/DescribeClusterAddonMetadata.json +++ b/en-US/cs/DescribeClusterAddonMetadata.json @@ -1,6 +1,6 @@ { "name": "DescribeClusterAddonMetadata", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "GET", "pathPattern": "/clusters/[cluster_id]/components/[component_id]/metadata", diff --git a/en-US/cs/DescribeClusterAddonsUpgradeStatus.json b/en-US/cs/DescribeClusterAddonsUpgradeStatus.json index cbc1ad1dc..d5906ab11 100644 --- a/en-US/cs/DescribeClusterAddonsUpgradeStatus.json +++ b/en-US/cs/DescribeClusterAddonsUpgradeStatus.json @@ -1,6 +1,6 @@ { "name": "DescribeClusterAddonsUpgradeStatus", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "GET", "pathPattern": "/clusters/[ClusterId]/components/upgradestatus", diff --git a/en-US/cs/DescribeClusterAddonsVersion.json b/en-US/cs/DescribeClusterAddonsVersion.json index 5187a3d66..973c8e367 100644 --- a/en-US/cs/DescribeClusterAddonsVersion.json +++ b/en-US/cs/DescribeClusterAddonsVersion.json @@ -1,6 +1,6 @@ { "name": "DescribeClusterAddonsVersion", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "GET", "pathPattern": "/clusters/[ClusterId]/components/version", diff --git a/en-US/cs/DescribeClustersV1.json b/en-US/cs/DescribeClustersV1.json index 86414ede4..742cbe9e8 100644 --- a/en-US/cs/DescribeClustersV1.json +++ b/en-US/cs/DescribeClustersV1.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "cluster_id", - "description": "", + "description": "集群ID。", "position": "Query", "type": "String", "required": false @@ -21,7 +21,7 @@ }, { "name": "cluster_type", - "description": "The type of cluster. Valid values:\n\n* `Kubernetes`: ACK dedicated cluster\n* `ManagedKubernetes`: ACK managed cluster, ACK Serverless cluster, or ACK Edge cluster\n* `Ask`: ACK Serverless cluster\n* `ExternalKubernetes`: registered cluster\n\nIf you want to query ACK Serverless clusters, specify ManagedKubernetes or Ask based on the value that you specified when you created the ACK Serverless clusters.", + "description": "The cluster type. Valid values:\n\n* `Kubernetes`: ACK dedicated cluster.\n* `ManagedKubernetes`: ACK managed cluster. ACK managed clusters include ACK Pro clusters, ACK Basic clusters, ACK Serverless Pro clusters, ACK Serverless Basic clusters, ACK Edge Pro clusters, and ACK Edge Basic clusters.\n* `ExternalKubernetes`: registered cluster.", "position": "Query", "type": "String", "required": false @@ -49,7 +49,7 @@ }, { "name": "profile", - "description": "The cluster identifier, which is available only when the cluster type is set to `ManagedKubernetes`. Valid values:\n\n* `Default`: ACK managed cluster\n* `Serverless`: ACK Serverless cluster\n* `Edge`: ACK Edge cluster\n\nBy default, this parameter is left empty, which means that ACK clusters are not filtered by this parameter.", + "description": "The identifier of the cluster. Valid values when the cluster_type parameter is set to `ManagedKubernetes`:\n\n* `Default`: ACK managed cluster\n* `Serverless`: ACK Serverless cluster\n* `Edge`: ACK Edge cluster\n\nValid values when the cluster_type parameter is set to `Ask`:\n\n`ask.v2`: ACK Serverless cluster\n\nBy default, this parameter is left empty. If you leave this parameter empty, ACK clusters are not filtered by identifier.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cs/DescribeExternalAgent.json b/en-US/cs/DescribeExternalAgent.json index d347d5f3e..5fdcf7c98 100644 --- a/en-US/cs/DescribeExternalAgent.json +++ b/en-US/cs/DescribeExternalAgent.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "AgentMode", - "description": "The agent mode.", + "description": "The permission mode of the agent. Valid values:\n\nadmin: the admin mode, which provides full permissions. restricted: the restricted mode, which provides partial permissions. Default value: admin.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cs/DescribeNodePoolVuls.json b/en-US/cs/DescribeNodePoolVuls.json index 1716e910f..a1d1250bc 100644 --- a/en-US/cs/DescribeNodePoolVuls.json +++ b/en-US/cs/DescribeNodePoolVuls.json @@ -14,7 +14,7 @@ }, { "name": "necessity", - "description": "", + "description": "The priority to fix the vulnerability. Separate multiple priorities with commas (,). Valid values:\n\n* `asap`: high\n* `later`: medium\n* `nntf`: low", "position": "Query", "type": "String", "required": false diff --git a/en-US/cs/GetClusterCheck.json b/en-US/cs/GetClusterCheck.json index 5e1f15c95..21f216a20 100644 --- a/en-US/cs/GetClusterCheck.json +++ b/en-US/cs/GetClusterCheck.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "check_id", - "description": "", + "description": "The ID of the cluster check task.", "position": "Path", "type": "String", "required": true }, { "name": "cluster_id", - "description": "", + "description": "The cluster ID.", "position": "Path", "type": "String", "required": true diff --git a/en-US/cs/GrantPermissions.json b/en-US/cs/GrantPermissions.json index 6be22a71e..3ce90d2fb 100644 --- a/en-US/cs/GrantPermissions.json +++ b/en-US/cs/GrantPermissions.json @@ -9,7 +9,7 @@ "name": "body", "description": "The request body.", "position": "Body", - "type": "RepeatList", + "type": "Json", "required": false, "sub_parameters": [ { diff --git a/en-US/cs/ListClusterChecks.json b/en-US/cs/ListClusterChecks.json index 9fb61b784..503fcdd85 100644 --- a/en-US/cs/ListClusterChecks.json +++ b/en-US/cs/ListClusterChecks.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "cluster_id", - "description": "", + "description": "The cluster ID.", "position": "Path", "type": "String", "required": false }, { "name": "type", - "description": "", + "description": "The check method.", "position": "Query", "type": "String", "required": false diff --git a/en-US/cs/ModifyCluster.json b/en-US/cs/ModifyCluster.json index 87dabd0bb..33c0746c1 100644 --- a/en-US/cs/ModifyCluster.json +++ b/en-US/cs/ModifyCluster.json @@ -14,7 +14,7 @@ }, { "name": "body", - "description": "The request body.", + "description": "The request parameters.", "position": "Body", "type": "String", "required": false diff --git a/en-US/cs/OpenAckService.json b/en-US/cs/OpenAckService.json index 7690cec76..06b89aa57 100644 --- a/en-US/cs/OpenAckService.json +++ b/en-US/cs/OpenAckService.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "type", - "description": "The type of ACK service that you want to activate. Valid values:\n\n* `propayasgo`: ACK Pro\n* `edgepayasgo`: ACK Edge\n* `gspayasgo`: ACK for Alibaba Cloud Genomics Service (AGS)", + "description": "The type of ACK service that you want to activate. Valid values:\n\n* `propayasgo`: ACK Pro\n* `edgepayasgo`: ACK Edge", "position": "Query", "type": "String", "required": false diff --git a/en-US/cs/PauseClusterUpgrade.json b/en-US/cs/PauseClusterUpgrade.json index 197597d03..b680d987c 100644 --- a/en-US/cs/PauseClusterUpgrade.json +++ b/en-US/cs/PauseClusterUpgrade.json @@ -1,6 +1,6 @@ { "name": "PauseClusterUpgrade", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "POST", "pathPattern": "/api/v2/clusters/[ClusterId]/upgrade/pause", diff --git a/en-US/cs/RemoveNodePoolNodes.json b/en-US/cs/RemoveNodePoolNodes.json index ab06930d4..cb35cfd05 100644 --- a/en-US/cs/RemoveNodePoolNodes.json +++ b/en-US/cs/RemoveNodePoolNodes.json @@ -21,7 +21,7 @@ }, { "name": "concurrency", - "description": "", + "description": "是否并发移除。", "position": "Query", "type": "Boolean", "required": false diff --git a/en-US/cs/RepairClusterNodePool.json b/en-US/cs/RepairClusterNodePool.json index 6305bd4c8..ce6a58f9c 100644 --- a/en-US/cs/RepairClusterNodePool.json +++ b/en-US/cs/RepairClusterNodePool.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "body", - "description": "The request body.", + "description": "The request parameters.", "position": "Body", "type": "String", "required": false diff --git a/en-US/cs/ResumeUpgradeCluster.json b/en-US/cs/ResumeUpgradeCluster.json index 1d1b9abef..ddc4ada36 100644 --- a/en-US/cs/ResumeUpgradeCluster.json +++ b/en-US/cs/ResumeUpgradeCluster.json @@ -1,6 +1,6 @@ { "name": "ResumeUpgradeCluster", - "deprecated": false, + "deprecated": true, "protocol": "HTTP|HTTPS", "method": "POST", "pathPattern": "/api/v2/clusters/[ClusterId]/upgrade/resume", diff --git a/en-US/cs/RunClusterCheck.json b/en-US/cs/RunClusterCheck.json index 2b00ee3d0..5c0d912d2 100644 --- a/en-US/cs/RunClusterCheck.json +++ b/en-US/cs/RunClusterCheck.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "body", - "description": "", + "description": "The request body.", "position": "Body", "type": "String", "required": false }, { "name": "cluster_id", - "description": "", + "description": "The cluster ID.", "position": "Path", "type": "String", "required": false diff --git a/en-US/cs/TagResources.json b/en-US/cs/TagResources.json index d49e61bd8..1c6221984 100644 --- a/en-US/cs/TagResources.json +++ b/en-US/cs/TagResources.json @@ -9,7 +9,7 @@ "name": "body", "description": "The request body.", "position": "Body", - "type": "Struct", + "type": "String", "required": false } ] diff --git a/en-US/cs/version.json b/en-US/cs/version.json index 90f8253de..993f8179b 100644 --- a/en-US/cs/version.json +++ b/en-US/cs/version.json @@ -15,7 +15,7 @@ "CancelClusterUpgrade": { "title": "CancelClusterUpgrade", "summary": "You can call the CancelClusterUpgrade operation to cancel the update of a cluster.", - "deprecated": false + "deprecated": true }, "CancelComponentUpgrade": { "title": "CancelComponentUpgrade", @@ -23,7 +23,8 @@ "deprecated": false }, "CancelOperationPlan": { - "title": null, + "title": "CancelOperationPlan", + "summary": "", "deprecated": false }, "CancelTask": { @@ -72,13 +73,13 @@ "deprecated": false }, "DeleteAlertContact": { - "title": null, - "summary": null, + "title": "DeleteAlertContact", + "summary": "", "deprecated": false }, "DeleteAlertContactGroup": { - "title": null, - "summary": null, + "title": "DeleteAlertContactGroup", + "summary": "", "deprecated": false }, "DeleteCluster": { @@ -127,23 +128,24 @@ "deprecated": false }, "DescribeAddon": { - "title": null, + "title": "DescribeAddon", + "summary": "", "deprecated": false }, "DescribeAddons": { "title": "DescribeAddons", "summary": "You can call the DescribeAddons operation to query the details about all components that are supported by Container Service for Kubernetes (ACK).", - "deprecated": false + "deprecated": true }, "DescribeClusterAddonInstance": { "title": "DescribeClusterAddonInstance", "summary": "You can call the DescribeClusterAddonInstance operation to query the information about a cluster component, including the version, status, and configuration of the component.", - "deprecated": false + "deprecated": true }, "DescribeClusterAddonMetadata": { "title": "DescribeClusterAddonMetadata", "summary": "You can call the DescribeClusterAddonMetadata operation to query the metadata of a component version. The metadata includes the component version and available parameters.", - "deprecated": false + "deprecated": true }, "DescribeClusterAddonUpgradeStatus": { "title": "DescribeClusterAddonUpgradeStatus", @@ -153,12 +155,12 @@ "DescribeClusterAddonsUpgradeStatus": { "title": "DescribeClusterAddonsUpgradeStatus", "summary": "You can call the DescribeClusterAddonsUpgradeStatus operation to query the update progress of a component by component name.", - "deprecated": false + "deprecated": true }, "DescribeClusterAddonsVersion": { "title": "DescribeClusterAddonsVersion", "summary": "You can call the DescribeClusterAddonsVersion operation to query the details about all components in a cluster by cluster ID.", - "deprecated": false + "deprecated": true }, "DescribeClusterAttachScripts": { "title": "DescribeClusterAttachScripts", @@ -326,7 +328,8 @@ "deprecated": false }, "GetClusterAddonInstance": { - "title": null, + "title": "GetClusterAddonInstance", + "summary": "", "deprecated": false }, "GetClusterCheck": { @@ -355,11 +358,13 @@ "deprecated": false }, "ListAddons": { - "title": null, + "title": "ListAddons", + "summary": "", "deprecated": false }, "ListClusterAddonInstances": { - "title": null, + "title": "ListClusterAddonInstances", + "summary": "", "deprecated": false }, "ListClusterChecks": { @@ -368,7 +373,8 @@ "deprecated": false }, "ListOperationPlans": { - "title": null, + "title": "ListOperationPlans", + "summary": "", "deprecated": false }, "ListTagResources": { @@ -419,7 +425,7 @@ "PauseClusterUpgrade": { "title": "PauseClusterUpgrade", "summary": "You can call the PauseClusterUpgrade operation to pause the update of a Container Service for Kubernetes (ACK) cluster.", - "deprecated": false + "deprecated": true }, "PauseComponentUpgrade": { "title": "PauseComponentUpgrade", @@ -459,7 +465,7 @@ "ResumeUpgradeCluster": { "title": "ResumeUpgradeCluster", "summary": "You can call the ResumeUpgradeCluster operation to resume the update of a cluster by cluster ID.", - "deprecated": false + "deprecated": true }, "RunClusterCheck": { "title": "RunClusterCheck", diff --git a/en-US/dcdn/AddDcdnDomain.json b/en-US/dcdn/AddDcdnDomain.json index 831d1aa07..0f19371b8 100644 --- a/en-US/dcdn/AddDcdnDomain.json +++ b/en-US/dcdn/AddDcdnDomain.json @@ -20,7 +20,7 @@ }, { "name": "FunctionType", - "description": "", + "description": "Computing service type. Valid values:\n\n* **routine**\n* **image**\n* **cloudFunction**", "position": "Query", "type": "String", "required": false @@ -34,7 +34,7 @@ }, { "name": "Scene", - "description": "", + "description": "The Acceleration scen. Supported:\n\n* apiscene:API acceleration.\n* webservicescene: accelerate website business.\n* staticscene: video and graphic acceleration.\n* (Empty): no scene.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dcdn/CreateDcdnCertificateSigningRequest.json b/en-US/dcdn/CreateDcdnCertificateSigningRequest.json new file mode 100644 index 000000000..46f8d6c79 --- /dev/null +++ b/en-US/dcdn/CreateDcdnCertificateSigningRequest.json @@ -0,0 +1,64 @@ +{ + "name": "CreateDcdnCertificateSigningRequest", + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "City", + "description": "The city. Default value: Hangzhou.", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "CommonName", + "description": "The Common Name of the certificate.", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "Country", + "description": "The country or region in which the organization is located. Default value: CN.", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Email", + "description": "The email address.", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Organization", + "description": "The name of the organization. Default value: Alibaba Inc.", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "OrganizationUnit", + "description": "The name of the department. Default value: Aliyun CDN.", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "SANs", + "description": "The Subject Alternative Name (SAN) extension that allows multiple domain names to be associated with the certificate. Separate multiple domain names with commas (,).", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "State", + "description": "The provincial district. Default value: Zhejiang.", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/dcdn/CreateDcdnWafGroup.json b/en-US/dcdn/CreateDcdnWafGroup.json index 087b6d422..ec2a33227 100644 --- a/en-US/dcdn/CreateDcdnWafGroup.json +++ b/en-US/dcdn/CreateDcdnWafGroup.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "Name", - "description": "", + "description": "The name of the WAF rule group. The name can be up to 128 characters in length. This parameter is required when you create a custom WAF rule group.", "position": "Body", "type": "String", "required": false }, { "name": "Subscribe", - "description": "", + "description": "Specifies whether to enable subscription. Valid values:\n\n* **on**\n* **off**\n\nWhen you replicate a custom rule group, do not specify this parameter.", "position": "Body", "type": "String", "required": false }, { "name": "TemplateId", - "description": "", + "description": "The ID of the rule group to be replicated. This parameter is required when you replicate a custom WAF rule group. You can call the [DescribeDcdnWafGroups](~~DescribeDcdnWafGroups~~) operation to query the ID of the rule group. If no template is used, set the value to 0 or do not specify this parameter.", "position": "Body", "type": "Long", "required": false diff --git a/en-US/dcdn/DeleteDcdnUserConfig.json b/en-US/dcdn/DeleteDcdnUserConfig.json index 5e744892b..6cdbd06c6 100644 --- a/en-US/dcdn/DeleteDcdnUserConfig.json +++ b/en-US/dcdn/DeleteDcdnUserConfig.json @@ -6,7 +6,7 @@ "parameters": [ { "name": "FunctionName", - "description": "", + "description": "The name of the user feature that you want to delete. Currently, only DCDN Web Application Firewall (WAF) can be deleted. Default value: waf.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dcdn/DeleteDcdnWafGroup.json b/en-US/dcdn/DeleteDcdnWafGroup.json index e4ba90212..bdc1008ac 100644 --- a/en-US/dcdn/DeleteDcdnWafGroup.json +++ b/en-US/dcdn/DeleteDcdnWafGroup.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "Id", - "description": "", + "description": "The ID of the custom WAF rule group.", "position": "Body", "type": "Long", "required": false diff --git a/en-US/dcdn/DescribeDcdnDomainUsageData.json b/en-US/dcdn/DescribeDcdnDomainUsageData.json index 3294d7dbc..9215acefd 100644 --- a/en-US/dcdn/DescribeDcdnDomainUsageData.json +++ b/en-US/dcdn/DescribeDcdnDomainUsageData.json @@ -13,28 +13,28 @@ }, { "name": "DataProtocol", - "description": "The protocol by which the data is queried. Valid values:\n\n* **quic**: Quick UDP Internet Connections (QUIC)\n* **https**: HTTPS\n* **http**: HTTP\n* **all**: HTTP, HTTPS, and QUIC\n\nDefault value: **all**", + "description": "The protocol of the data to query. Valid values:\n\n* **quic**: Quick UDP Internet Connections (QUIC)\n* **https**: HTTPS\n* **http**: HTTP\n* **all**: all the preceding protocols\n\nDefault value: **all**", "position": "Query", "type": "String", "required": false }, { "name": "DomainName", - "description": "The accelerated domain name. You can specify up to 100 domain names in each request. Separate multiple domain names with commas (,).\n\n> If you do not specify this parameter, the usage data of all accelerated domain names that belong to your Alibaba Cloud account is returned.", + "description": "The accelerated domain name. You can specify up to 100 domain names in each request. Separate multiple domain names with commas (,).\n\n> If you do not specify this parameter, the usage data of all accelerated domain names that belong to your Alibaba Cloud account is returned.", "position": "Query", "type": "String", "required": false }, { "name": "EndTime", - "description": "The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\n> The end time must be later than the start time. The maximum time range that can be queried is 31 days.", + "description": "The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\n> The end time must be later than the start time. The maximum time range that can be queried is 31 days.", "position": "Query", "type": "String", "required": true }, { "name": "Field", - "description": "The type of data that you want to query. Valid values:\n\n* **bps**: bandwidth\n* **traf**: traffic\n* **acc**: requests\n\n> If the value is set to **acc**, the **Area** parameter is not supported.", + "description": "The type of data that you want to query. Valid values:\n\n* **bps**: bandwidth\n* **traf**: traffic\n* **acc**: requests\n\n> **acc** does not support the **Area** parameter.", "position": "Query", "type": "String", "required": true @@ -48,14 +48,14 @@ }, { "name": "StartTime", - "description": "The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\n> The minimum time granularity at which the data is queried is 5 minutes.", + "description": "The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\n> The minimum time granularity at which the data is queried is 5 minutes.", "position": "Query", "type": "String", "required": true }, { "name": "Type", - "description": "请求数类型，取值：\n\n- **static**：静态。\n- **dynamic**：动态。\n- **all**：全部。\n\n默认为**all**。", + "description": "The type of the requests. Valid values:\n\n* **static**: static requests\n* **dynamic**: dynamic requests\n* **all**: all requests\n\nDefault value: **all**", "position": "Query", "type": "String", "required": false diff --git a/en-US/dcdn/DescribeDcdnOriginSiteHealthStatus.json b/en-US/dcdn/DescribeDcdnOriginSiteHealthStatus.json index 669b52dd2..edc68360d 100644 --- a/en-US/dcdn/DescribeDcdnOriginSiteHealthStatus.json +++ b/en-US/dcdn/DescribeDcdnOriginSiteHealthStatus.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "DomainName", - "description": "", + "description": "The accelerated domain name. You can specify only one domain name in each request.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dcdn/DescribeDcdnSSLCertificateList.json b/en-US/dcdn/DescribeDcdnSSLCertificateList.json new file mode 100644 index 000000000..1de355ac4 --- /dev/null +++ b/en-US/dcdn/DescribeDcdnSSLCertificateList.json @@ -0,0 +1,43 @@ +{ + "name": "DescribeDcdnSSLCertificateList", + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "DomainName", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "PageNumber", + "description": "", + "position": "Query", + "type": "Long", + "required": false + }, + { + "name": "PageSize", + "description": "", + "position": "Query", + "type": "Long", + "required": false + }, + { + "name": "SearchKeyword", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "SecurityToken", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/dcdn/DescribeDcdnUserVipsByDomain.json b/en-US/dcdn/DescribeDcdnUserVipsByDomain.json index a0af2390e..38b0c2e3a 100644 --- a/en-US/dcdn/DescribeDcdnUserVipsByDomain.json +++ b/en-US/dcdn/DescribeDcdnUserVipsByDomain.json @@ -6,14 +6,14 @@ "parameters": [ { "name": "Available", - "description": "", + "description": "Specifies whether to query the virtual IP addresses of only healthy POPs. Valid value:\n\n* **on**: queries healthy VIPs.\n* **off**: queries all VIPs.", "position": "Query", "type": "String", "required": false }, { "name": "DomainName", - "description": "", + "description": "The accelerated domain name. You can specify only one domain name.\n\nEnumeration values: example.com", "position": "Query", "type": "String", "required": true diff --git a/en-US/dcdn/DescribeDcdnWafDefaultRules.json b/en-US/dcdn/DescribeDcdnWafDefaultRules.json index 4aa147dd1..7cbd71b98 100644 --- a/en-US/dcdn/DescribeDcdnWafDefaultRules.json +++ b/en-US/dcdn/DescribeDcdnWafDefaultRules.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "QueryArgs", - "description": "", + "description": "The query conditions. The value is a string in the JSON format. Format: `QueryArgs={\"DefenseScene\":\"anti_scan\"}`", "position": "Query", "type": "String", "required": false diff --git a/en-US/dcdn/DescribeDcdnWafGroup.json b/en-US/dcdn/DescribeDcdnWafGroup.json index 41e955fe1..7248d5f07 100644 --- a/en-US/dcdn/DescribeDcdnWafGroup.json +++ b/en-US/dcdn/DescribeDcdnWafGroup.json @@ -7,42 +7,42 @@ "parameters": [ { "name": "Id", - "description": "", + "description": "The ID of the WAF rule group. You can query the ID by calling the [DescribeDcdnWafGroups](~~DescribeDcdnWafGroups~~) operation.", "position": "Query", "type": "Long", "required": true }, { "name": "Language", - "description": "", + "description": "The language of the response. Valid values:\n\n* **en**: English\n* **zh**: Chinese", "position": "Query", "type": "String", "required": true }, { "name": "PageNumber", - "description": "", + "description": "The number of the page to return. Default value: **1**.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "", + "description": "The number of entries to return on each page. Default value: **20**.", "position": "Query", "type": "Integer", "required": false }, { "name": "QueryArgs", - "description": "", + "description": "The query conditions. The value needs to be a JSON string in the following format: Format:\n\n`QueryArgs={\"PolicyIds\":\"IDs of protection policies\",\"RuleIds\":\"IDs of protection rules\",\"RuleNameLike\":\"Names of protection rules\",\"DomainNames\":\"Protected domain names\",\"DefenseScenes\":\"waf_group\",\"RuleStatus\":\"on\",\"OrderBy\":\"GmtModified\",\"Desc\":\"false\"}`\n\n> If you do not specify this parameter, all protection rules are queried.", "position": "Query", "type": "String", "required": false }, { "name": "Scope", - "description": "", + "description": "The range of the rule group to be queried.\n\n* **in**: rules in the rule group are returned.\n* **out**: rules that are in the full rule set but are not in the rule group are returned.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dcdn/DescribeDcdnWafGroups.json b/en-US/dcdn/DescribeDcdnWafGroups.json index 8f426a36f..97756d094 100644 --- a/en-US/dcdn/DescribeDcdnWafGroups.json +++ b/en-US/dcdn/DescribeDcdnWafGroups.json @@ -7,28 +7,28 @@ "parameters": [ { "name": "Language", - "description": "", + "description": "The language of the response. Valid values:\n\n* **en**: English\n* **zh**: Chinese", "position": "Query", "type": "String", "required": false }, { "name": "PageNumber", - "description": "", + "description": "The number of the page to return. Default value: **1**.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "", + "description": "The number of entries to return on each page. Default value: **20**.", "position": "Query", "type": "Integer", "required": false }, { "name": "QueryArgs", - "description": "", + "description": "The query conditions. The value is a string in the JSON format. Format: `QueryArgs={\"PolicyIds\":\"IDs of protection policies\",\"RuleIds\":\"IDs of the protection rules\",\"RuleNameLike\":\"Names of the protection rule\",\"DomainNames\":\"Protected domain names\",\"DefenseScenes\":\"waf_group\",\"RuleStatus\":\"on\",\"OrderBy\":\"GmtModified\",\"Desc\":\"false\"}`\n\n> If you do not specify this parameter, all protection rules are queried.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dcdn/RefreshDcdnObjectCaches.json b/en-US/dcdn/RefreshDcdnObjectCaches.json index 6710f8ea9..77d1f3ba3 100644 --- a/en-US/dcdn/RefreshDcdnObjectCaches.json +++ b/en-US/dcdn/RefreshDcdnObjectCaches.json @@ -6,7 +6,7 @@ "parameters": [ { "name": "Force", - "description": "", + "description": "Specifies whether to refresh resources in a directory if the resources are different from the resources in the same directory in the origin server. Default value: false.\n\n* **true**: refresh all resources in the directory.\n* **false**: refresh the changed resources in the directory.", "position": "Query", "type": "Boolean", "required": false diff --git a/en-US/dcdn/SetDcdnDomainCSRCertificate.json b/en-US/dcdn/SetDcdnDomainCSRCertificate.json new file mode 100644 index 000000000..54d44ec46 --- /dev/null +++ b/en-US/dcdn/SetDcdnDomainCSRCertificate.json @@ -0,0 +1,22 @@ +{ + "name": "SetDcdnDomainCSRCertificate", + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "DomainName", + "description": "The domain name that is secured by the certificate. The domain name uses HTTPS acceleration.", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "ServerCertificate", + "description": "The content of the certificate. The certificate must match the certificate signing request (CSR) created by calling the [CreateDcdnCertificateSigningRequest](~~144478~~) operation. Make sure that the certificate is in PEM format and its content is Base64-encoded and then encoded by encodeURIComponent.", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/dcdn/SetDcdnDomainSSLCertificate.json b/en-US/dcdn/SetDcdnDomainSSLCertificate.json index 38ebaf82e..50963230d 100644 --- a/en-US/dcdn/SetDcdnDomainSSLCertificate.json +++ b/en-US/dcdn/SetDcdnDomainSSLCertificate.json @@ -41,7 +41,7 @@ }, { "name": "Env", - "description": "", + "description": "Specifies whether the certificate is issued in canary releases. If you set this parameter to **staging**, the certificate is issued in canary releases. If you do not specify this parameter or set this parameter to other values, the certificate is officially issued.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dcdn/SetDcdnFullDomainsBlockIP.json b/en-US/dcdn/SetDcdnFullDomainsBlockIP.json index 5690d4018..9ebe7f93a 100644 --- a/en-US/dcdn/SetDcdnFullDomainsBlockIP.json +++ b/en-US/dcdn/SetDcdnFullDomainsBlockIP.json @@ -6,28 +6,28 @@ "parameters": [ { "name": "BlockInterval", - "description": "The blocking period. Unit: seconds.\n\n> If you set the **OperationType** parameter to **unblock**, you do not need to set this parameter.", + "description": "The duration for which IP addresses or CIDR blocks are blocked. Unit: seconds. The value **0** specifies that IP addresses or CIDR blocks are permanently blocked. This parameter is available only if you set **OperationType** to **block**.", "position": "Body", "type": "Integer", "required": false }, { "name": "IPList", - "description": "The IP addresses that are blocked or unblocked. Separate multiple IP addresses with commas (,). You can specify up to 1,000 IP addresses.", + "description": "The IP addresses that you want to block or unblock. Separate multiple IP addresses with commas (,). You can specify up to 1,000 IP addresses.", "position": "Body", "type": "String", "required": true }, { "name": "OperationType", - "description": "The action. Valid values:\n\n* **block**\n* **unblock**", + "description": "The action that you want to perform. Valid values:\n\n* **block**\n* **unblock**", "position": "Body", "type": "String", "required": true }, { "name": "UpdateType", - "description": "", + "description": "The type of the blocking duration. This parameter is available only if you set **OperationType** to **block**. Valid values:\n\n* **cover**: the blocking duration that is specified in the request takes effect.\n* **uncover**: the longer one of the blocking duration that is specified in the request and the remaining blocking duration takes effect.\n* Default value: cover.", "position": "Body", "type": "String", "required": false diff --git a/en-US/dcdn/version.json b/en-US/dcdn/version.json index 883e6f2fd..cfcb6ec2c 100644 --- a/en-US/dcdn/version.json +++ b/en-US/dcdn/version.json @@ -82,6 +82,11 @@ "summary": "Generates an official code version from unstable JavaScript code that is in the staging\n environment. The version can be used in the canary release or production environment.\n \n ", "deprecated": false }, + "CreateDcdnCertificateSigningRequest": { + "title": "CreateDcdnCertificateSigningRequest", + "summary": "Creates a certificate signing request (CSR) file.", + "deprecated": false + }, "CreateDcdnDeliverTask": { "title": "CreateDcdnDeliverTask", "summary": "Creates a tracking task. After you create a tracking task, the system periodically sends operations reports to you by email.", @@ -602,6 +607,11 @@ "summary": "Queries the ShangMi (SM) certificates of an accelerated domain name.", "deprecated": false }, + "DescribeDcdnSSLCertificateList": { + "title": "DescribeDcdnSSLCertificateList", + "summary": "Queries the certificates of accelerated domain names.", + "deprecated": false + }, "DescribeDcdnSecFuncInfo": { "title": "DescribeDcdnSecFuncInfo", "summary": "Creates an edge security drop-down list in the Dynamic Content Delivery Network (DCDN) console.", @@ -973,8 +983,8 @@ "deprecated": false }, "RefreshErObjectCaches": { - "title": null, - "summary": null, + "title": "RefreshErObjectCaches", + "summary": "Refreshes the cache that is written by calling the cache operation of EdgeRoutine. You can refresh multiple URLs in each request.", "deprecated": false }, "RollbackDcdnStagingConfig": { @@ -982,6 +992,11 @@ "summary": "Rolls back the configurations of an accelerated domain name from the staging environment to the production environment.", "deprecated": false }, + "SetDcdnDomainCSRCertificate": { + "title": "SetDcdnDomainCSRCertificate", + "summary": "Configures an SSL certificate for a specified domain name.", + "deprecated": false + }, "SetDcdnDomainCertificate": { "title": "SetDcdnDomainCertificate", "summary": "Enables or disables the SSL certificate for a domain name and modifies certificate details.", @@ -1004,7 +1019,7 @@ }, "SetDcdnFullDomainsBlockIP": { "title": "SetDcdnFullDomainsBlockIP", - "summary": "Configures IP addresses that are blocked or unblocked from accessing resources of Alibaba Cloud Dynamic Content Delivery Network (DCDN).", + "summary": "Blocks or unblocks IP addresses or CIDR blocks.", "deprecated": false }, "SetDcdnUserConfig": { diff --git a/en-US/ddoscoo/DescribeInstanceExt.json b/en-US/ddoscoo/DescribeInstanceExt.json index cf4d5e21e..e9a38e84a 100644 --- a/en-US/ddoscoo/DescribeInstanceExt.json +++ b/en-US/ddoscoo/DescribeInstanceExt.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "InstanceId", - "description": "", + "description": "The ID of the instance.\n\n> You can call the [DescribeInstanceIds](~~157459~~) operation to query the IDs of all instances.", "position": "Query", "type": "String", "required": false }, { "name": "PageNumber", - "description": "", + "description": "The number of the page. For example, to query the returned results on the first page, set the value to **1**.", "position": "Query", "type": "String", "required": false }, { "name": "PageSize", - "description": "", + "description": "The number of entries per page.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ddoscoo/DescribeSlaEventList.json b/en-US/ddoscoo/DescribeSlaEventList.json index d11be70cc..8179a686c 100644 --- a/en-US/ddoscoo/DescribeSlaEventList.json +++ b/en-US/ddoscoo/DescribeSlaEventList.json @@ -7,42 +7,42 @@ "parameters": [ { "name": "EndTime", - "description": "", + "description": "The end of the time range to query. The value is a UNIX timestamp. Unit: seconds.\n\n> This UNIX timestamp must indicate a point in time that is accurate to the minute.", "position": "Query", "type": "Long", "required": true }, { "name": "Ip", - "description": "", + "description": "The IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance.", "position": "Query", "type": "String", "required": false }, { "name": "Page", - "description": "", + "description": "The page number.", "position": "Query", "type": "Long", "required": false }, { "name": "PageSize", - "description": "", + "description": "The number of entries per page.", "position": "Query", "type": "Long", "required": false }, { "name": "Region", - "description": "", + "description": "The type of the service Valid values:\n\n* **cn**: Anti-DDoS Pro\n* **cn-hongkong**: Anti-DDoS Premium", "position": "Query", "type": "String", "required": true }, { "name": "StartTime", - "description": "", + "description": "The beginning of the time range to query. The value is a UNIX timestamp. Unit: seconds.\n\n> This UNIX timestamp must indicate a point in time that is accurate to the minute.", "position": "Query", "type": "Long", "required": true diff --git a/en-US/ddoscoo/version.json b/en-US/ddoscoo/version.json index d823e9c1a..841e73f36 100644 --- a/en-US/ddoscoo/version.json +++ b/en-US/ddoscoo/version.json @@ -219,7 +219,7 @@ }, "DescribeCerts": { "title": "DescribeCerts", - "summary": "Queries the certificate information about a website.", + "summary": "Queries information about all certificates that can be associated with the current domain name instead of the certificate currently in use. To query the information about the certificate that is currently in use, you can call the DescribeWebRules operation and view the values of the CertName and CertRegion response parameters.", "deprecated": false }, "DescribeCnameReuses": { @@ -488,8 +488,8 @@ "deprecated": false }, "DescribeSlaEventList": { - "title": null, - "summary": null, + "title": "DescribeSlaEventList", + "summary": "Queries the destination rate limit events.", "deprecated": false }, "DescribeSlsAuthStatus": { @@ -593,7 +593,7 @@ "deprecated": false }, "DescribeWebPreciseAccessRule": { - "title": "", + "title": "DescribeWebPreciseAccessRule", "summary": "Queries the accurate access control rules that are created for websites.", "deprecated": false }, @@ -789,7 +789,7 @@ }, "ModifyWebIpSetSwitch": { "title": "ModifyWebIpSetSwitch", - "summary": "Enables or disables the Blacklist/Whitelist (Domain Names) policy for a domain name.", + "summary": "Enables or disables the Black Lists and White Lists (Domain Names) policy for a domain name.", "deprecated": false }, "ModifyWebPreciseAccessRule": { diff --git a/en-US/dds/AllocateNodePrivateNetworkAddress.json b/en-US/dds/AllocateNodePrivateNetworkAddress.json index 34cfa4f7b..b2cc63355 100644 --- a/en-US/dds/AllocateNodePrivateNetworkAddress.json +++ b/en-US/dds/AllocateNodePrivateNetworkAddress.json @@ -6,14 +6,14 @@ "parameters": [ { "name": "AccountName", - "description": "The name of the account.\n\n> * The name must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (\\_). It must start with a lowercase letter.\n> * You need to set the account name and password only when you apply for an endpoint for a shard or Configserver node for the first time. In this case, the account name and password are used for all shard and Configserver nodes.\n> * The permissions of this account are fixed to read-only.", + "description": "The username of the account.\n\n> \n\n* The username must be 4 to 16 characters in length and can contain lowercase letters, digits, and underscores (\\_). The username must start with a lowercase letter.\n\n* You must configure the account and password only when you apply for the endpoint of a shard or Configserver node for the first time. The account and password are required for all shard and Configserver nodes.\n\n* The permissions of this account are fixed to read-only.", "position": "Query", "type": "String", "required": false }, { "name": "AccountPassword", - "description": "The password of the account.\n\n* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `!#$%^&*()_+-=`\n* The password must be 8 to 32 characters in length.", + "description": "The password for the account.\n\n* The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include `! # $ % ^ & * ( ) _ + - =`\n* The password must be 8 to 32 characters in length.", "position": "Query", "type": "String", "required": false @@ -34,7 +34,7 @@ }, { "name": "ZoneId", - "description": "The zone ID of the instance.\n\n> You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the zone ID of the instance.", + "description": "The ID of the zone to which the instance belongs.\n\n> You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the zone ID of the instance.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/CheckRecoveryCondition.json b/en-US/dds/CheckRecoveryCondition.json index 4dd8def82..5713235d1 100644 --- a/en-US/dds/CheckRecoveryCondition.json +++ b/en-US/dds/CheckRecoveryCondition.json @@ -7,28 +7,28 @@ "parameters": [ { "name": "BackupId", - "description": "The ID of the backup.\n\n> * You can call the [DescribeBackups](~~62172~~) operation to query the ID of the backup.\n> * You must specify one of the **RestoreTime** and BackupId parameters.\n> * This parameter is not applicable to sharded cluster instances.", + "description": "The backup ID.\n\n> * You can call the [DescribeBackups](~~62172~~) operation to query the backup ID.\n> * You must specify one of the **RestoreTime** and BackupId parameters.\n> * This parameter is not applicable to sharded cluster instances.", "position": "Query", "type": "String", "required": false }, { "name": "DatabaseNames", - "description": "The name of the source database. The value is a JSON array.\n\n> If you do not specify this parameter, all databases are restored.", + "description": "The name of the source database. The value is a JSON array.\n\n> If you do not specify this parameter, all databases are restored by default.", "position": "Query", "type": "String", "required": false }, { "name": "ResourceGroupId", - "description": "The ID of the resource group.", + "description": "The ID of the resource group to which the instance belongs.", "position": "Query", "type": "String", "required": false }, { "name": "RestoreTime", - "description": "The point in time to which the instance is restored. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\n> * The value can be any time within the past seven days. The time must be earlier than the current time, but later than the time when the instance was created.\n> * You must specify one of the RestoreTime and **BackupId** parameters.", + "description": "The point in time to which the instance is restored. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\n> * The time can be a point in time within the past seven days. The time must be earlier than the current time, but later than the time when the instance was created.\n> * You must specify one of the RestoreTime and **BackupId** parameters.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/CreateDBInstance.json b/en-US/dds/CreateDBInstance.json index 6c520c725..4c9ed9dc5 100644 --- a/en-US/dds/CreateDBInstance.json +++ b/en-US/dds/CreateDBInstance.json @@ -133,7 +133,7 @@ }, { "name": "NetworkType", - "description": "The network type of the instance. Set the value to VPC.", + "description": "The network type of the instance. Valid value:\n\n**VPC**: Virtual Private Cloud (VPC)", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/CreateShardingDBInstance.json b/en-US/dds/CreateShardingDBInstance.json index 23e3c0451..f90a97ded 100644 --- a/en-US/dds/CreateShardingDBInstance.json +++ b/en-US/dds/CreateShardingDBInstance.json @@ -141,7 +141,7 @@ }, { "name": "ProvisionedIops", - "description": "The provisioned IOPS. Valid values: 0 to 50000.", + "description": "The provisioned IOPS of the instance:", "position": "Query", "type": "Long", "required": false @@ -231,7 +231,7 @@ }, { "name": "Tag", - "description": "The custom tags added to the instance.", + "description": "The custom tags that you want to add to the instance.", "position": "Query", "type": "RepeatList", "required": false, diff --git a/en-US/dds/DescribeActiveOperationTaskType.json b/en-US/dds/DescribeActiveOperationTaskType.json index 234596fb5..c89eeb3cf 100644 --- a/en-US/dds/DescribeActiveOperationTaskType.json +++ b/en-US/dds/DescribeActiveOperationTaskType.json @@ -6,14 +6,14 @@ "parameters": [ { "name": "IsHistory", - "description": "Specifies whether to return all O\\&M tasks. Valid values:\n\n* **0**: returns only pending tasks.\n* **1**: returns all tasks.\n\nDefault value: **0**.", + "description": "Specifies whether to return historical O\\&M tasks. Valid values:\n\n* **0** (default): The system returns only pending O\\&M tasks.\n* **1**: The system returns historical O\\&M tasks.", "position": "Query", "type": "Integer", "required": false }, { "name": "ResourceGroupId", - "description": "The ID of the resource group.", + "description": "The resource group ID. You can call the [DescribeSecurityGroupConfiguration](~~146130~~) operation to query the resource group ID.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/DescribeActiveOperationTasks.json b/en-US/dds/DescribeActiveOperationTasks.json index ebaa03271..16994aff0 100644 --- a/en-US/dds/DescribeActiveOperationTasks.json +++ b/en-US/dds/DescribeActiveOperationTasks.json @@ -6,21 +6,21 @@ "parameters": [ { "name": "AllowCancel", - "description": "Specifies whether the task can be canceled.", + "description": "Specifies whether the task can be canceled. Valid values: -**0**: The task cannot be canceled. -**1**: The task can be canceled.", "position": "Query", "type": "Integer", "required": false }, { "name": "AllowChange", - "description": "Specifies whether the time can be changed. Valid values: -**0**: The time cannot be changed. **1**: The time can be changed.", + "description": "Specifies whether the time can be modified. Valid values: -**0**: The time cannot be modified. -**1**: The time can be modified.", "position": "Query", "type": "Integer", "required": false }, { "name": "ChangeLevel", - "description": "The change type.", + "description": "The type of configuration change. Valid values: -**all** (default): All O\\&M tasks are returned. -**S0**: O\\&M tasks that are executed for exception fixing are returned. -**S1**: O\\&M tasks that are executed for regular O\\&M are returned.", "position": "Query", "type": "String", "required": false @@ -41,14 +41,14 @@ }, { "name": "PageNumber", - "description": "The number of the page to return.", + "description": "The page number of the page to return.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "The number of entries to return per page. Valid values: **30, 50, and 100**. Default value: **30**.", + "description": "The number of entries to return on each page. Valid values: **30, 50, and 100**. Default value: **30**.", "position": "Query", "type": "Integer", "required": false @@ -62,7 +62,7 @@ }, { "name": "Region", - "description": "The region of the instance.", + "description": "The region of the instance. If you set the Region parameter to all, all tasks created within your Alibaba Cloud account are queried. In this case, you must also set the TaskType parameter to all.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/DescribeAuditRecords.json b/en-US/dds/DescribeAuditRecords.json index da594cfd8..0b6d83083 100644 --- a/en-US/dds/DescribeAuditRecords.json +++ b/en-US/dds/DescribeAuditRecords.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "DBInstanceId", - "description": "The ID of the instance.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.", + "description": "The instance ID.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.", "position": "Query", "type": "String", "required": true @@ -21,21 +21,28 @@ }, { "name": "EndTime", - "description": "The end of the time range to query. The end time must be later than the start time. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.\n\n> The end time must be within 24 hours from the start time. Otherwise, the query fails.", + "description": "The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.\n\n> The end time must be within 24 hours from the start time. Otherwise, the query fails.", "position": "Query", "type": "String", "required": true }, { "name": "Form", - "description": "The form of the audit log that the operation returns. Default value: File. Valid values:\n\n* **File** triggers the generation of audit logs. If this parameter is set to File, only common parameters are returned.\n* **Stream**: returns data streams.", + "description": "The form of the audit log that the operation returns. Valid values:\n\n* **File**: triggers the generation of audit logs. If this parameter is set to File, only common parameters are returned.\n* **Stream** (default): returns data streams.", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "LogicalOperator", + "description": "The logical relationship between multiple keywords. Valid values:\n\n* **or**\n* **and** (default value)", "position": "Query", "type": "String", "required": false }, { "name": "NodeId", - "description": "The ID of the mongos node or shard node whose parameter modification records you want to query in the instance. If the instance is a sharded cluster instance, you must specify this parameter.\n\n> This parameter is valid only when you specify the **DBInstanceId** parameter to the ID of a sharded cluster instance.", + "description": "The ID of the mongos node or shard node in the instance.\n\n> This parameter takes effect only when you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.", "position": "Query", "type": "String", "required": false @@ -49,7 +56,7 @@ }, { "name": "PageNumber", - "description": "The number of the page to return. Pages start from page 1. Valid values: any non-zero positive integer. Default value: 1.", + "description": "The page number of the page to return. The valid value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: 1.", "position": "Query", "type": "Integer", "required": false @@ -63,21 +70,21 @@ }, { "name": "QueryKeywords", - "description": "The keywords that are used for queries. Separate multiple keywords with spaces. The maximum number of keywords is 10.", + "description": "The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces.", "position": "Query", "type": "String", "required": false }, { "name": "StartTime", - "description": "The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.", + "description": "The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.", "position": "Query", "type": "String", "required": true }, { "name": "User", - "description": "The account of the database. If you do not specify this parameter, this operation returns records of all accounts.", + "description": "The user of the database. If you do not specify this parameter, this operation returns records of all users.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/DescribeAvailabilityZones.json b/en-US/dds/DescribeAvailabilityZones.json index bad19212f..455303d6c 100644 --- a/en-US/dds/DescribeAvailabilityZones.json +++ b/en-US/dds/DescribeAvailabilityZones.json @@ -7,56 +7,56 @@ "parameters": [ { "name": "AcceptLanguage", - "description": "Specifies the language of the returned values of the **RegionName** and **ZoneName** parameters. Default value: zh. Valid values:\n\n* **zh**: Chinese.\n* **en**: English", + "description": "The language of the values of the returned **RegionName** and **ZoneName** parameters. Valid values:\n\n* **zh** (default): Chinese\n* **en**: English", "position": "Query", "type": "String", "required": false }, { "name": "DBInstanceClass", - "description": "", + "description": "The instance type of the instance.", "position": "Query", "type": "String", "required": false }, { "name": "DbType", - "description": "The database engine type of the instance. Valid values:\n\n* **normal**: replica set instance\n* **sharding**: sharded cluster instance", + "description": "The architecture of the instance. Valid values:\n\n* **normal**: replica set instance\n* **sharding**: sharded cluster instance", "position": "Query", "type": "String", "required": false }, { "name": "EngineVersion", - "description": "", + "description": "The database engine version of the instance.", "position": "Query", "type": "String", "required": false }, { "name": "ExcludeSecondaryZoneId", - "description": "", + "description": "The secondary zone ID that is excluded from the query results. You can configure the ExcludeZoneId and ExcludeSecondaryZoneId parameters to specify the IDs of multiple zones that are excluded from the query results.", "position": "Query", "type": "String", "required": false }, { "name": "ExcludeZoneId", - "description": "", + "description": "The zone ID that is excluded from the query results.", "position": "Query", "type": "String", "required": false }, { "name": "InstanceChargeType", - "description": "The billing method of the instance. Default value: PrePaid. Valid values:\n\n* **PrePaid**: subscription\n* **PostPaid**: pay-as-you-go", + "description": "The billing method. Valid values:\n\n* **PrePaid** (default): subscription\n* **PostPaid**: pay-as-you-go", "position": "Query", "type": "String", "required": false }, { "name": "MongoType", - "description": "The edition of the ApsaraDB for MongoDB instance. The instance can be of a high-availability edition or beta edition.", + "description": "The edition of the instance. High-Available Edition and Preview Edition (dbfs) are supported.", "position": "Query", "type": "String", "required": false @@ -68,6 +68,13 @@ "type": "String", "required": true }, + { + "name": "ReplicationFactor", + "description": "The number of nodes. This parameter is available only for replica set instances.", + "position": "Query", + "type": "String", + "required": false + }, { "name": "ResourceGroupId", "description": "The ID of the resource group. For more information, see [View basic information of a resource group](~~151181~~).", @@ -77,14 +84,14 @@ }, { "name": "StorageSupport", - "description": "The zones to be displayed. The values include the zones in which you can create an instance that uses cloud disks, the zones in which you can create an instance that uses local disks, and the zones in which you can create an instance that uses cloud disks and local disks.", + "description": "The storage type of the instance. \n- **cloud**: The system displays only zones in which cloud disk-based instances can be deployed. \n- **local**: The system displays only zones in which local disk-based instances can be deployed. \n- **default** or null: The system displays only zones in which cloud disk-based and local disk-based instances can be deployed.", "position": "Query", "type": "String", "required": false }, { "name": "StorageType", - "description": "The storage type of the instance. Valid values:\n\n* **cloud_essd1**: PL1.enhanced SSD (ESSD)\n* **cloud_essd2**: PL2 ESSD.\n* **cloud_essd3**: PL3 ESSD.\n* **local_ssd**: local SSD.\n\n> \n\n* Instances of MongoDB 4.4 and later only support cloud disks. **cloud_essd1** is selected if you leave this parameter empty.\n\n* Instances of MongoDB 4.2 and earlier support only local disks. **local_ssd** is selected if you leave this parameter empty.", + "description": "The storage type of the instance. Valid values:\n\n* **cloud_essd1**: PL1 enhanced SSD (ESSD)\n* **cloud_essd2**: PL2 ESSD\n* **cloud_essd3**: PL3 ESSD\n* **local_ssd**: Local SSD\n\n> * Instances that run MongoDB 4.4 or later support only cloud disks. **cloud_essd1** is selected if you leave this parameter empty.\n> * Instances that run MongoDB 4.2 and earlier support only local disks. **local_ssd** is selected if you leave this parameter empty.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/DescribeAvailableResource.json b/en-US/dds/DescribeAvailableResource.json index 9c864a881..0bf121fab 100644 --- a/en-US/dds/DescribeAvailableResource.json +++ b/en-US/dds/DescribeAvailableResource.json @@ -21,7 +21,7 @@ }, { "name": "EngineVersion", - "description": "The database engine version of the instance.", + "description": "The major engine version of the instance.", "position": "Query", "type": "String", "required": false @@ -40,6 +40,13 @@ "type": "String", "required": true }, + { + "name": "ReplicationFactor", + "description": "The number of nodes, only applicable to replica sets.", + "position": "Query", + "type": "String", + "required": false + }, { "name": "ResourceGroupId", "description": "The ID of the resource group.", @@ -49,7 +56,7 @@ }, { "name": "StorageType", - "description": "The storage type of the instance. Valid values:\n\n- **local_ssd**: local SSD \n- **cloud_essd1**: PL1 enhanced SSD (ESSD) \n- **cloud_essd2**: PL2 ESSD \n- **cloud_essd3**: PL3 ESSD \n- **cloud_auto**: ESSD AutoPL \n\nBy default, this parameter is empty, which indicates that all types of storage resources are queried.", + "description": "The storage type of the instance. Valid values:\n\n* local_ssd: local SSD\n* cloud_essd1: PL1 enhanced SSD (ESSD)\n* cloud_essd2: PL2 ESSD\n* cloud_essd3: PL3 ESSD\n* cloud_auto: ESSD AutoPL disk\n\nThis parameter is empty by default, which indicates all types of storage resources are queried.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/DescribeBackups.json b/en-US/dds/DescribeBackups.json index 579889f23..ce6751a06 100644 --- a/en-US/dds/DescribeBackups.json +++ b/en-US/dds/DescribeBackups.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "BackupId", - "description": "The ID of the backup set. You can call the [CreateBackup](~~62171~~) operation to obtain the value of this parameter.\n\nIf you set the DBInstanceId parameter to the ID of a sharded cluster instance, the number of backup IDs is the same as the number of shards. Multiple , with commas (,) in the middle.", + "description": "The ID of the backup set. You can call the [CreateBackup](~~62171~~) operation to obtain the value of this parameter.\n\nIf you set the DBInstanceId parameter to the ID of a sharded cluster instance, the number of backup IDs is the same as the number of shards. Separate them with commas (,) in the middle.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/DescribeDBInstanceMonitor.json b/en-US/dds/DescribeDBInstanceMonitor.json index 8bcbcd855..811e197b4 100644 --- a/en-US/dds/DescribeDBInstanceMonitor.json +++ b/en-US/dds/DescribeDBInstanceMonitor.json @@ -6,7 +6,7 @@ "parameters": [ { "name": "DBInstanceId", - "description": "The ID of the instance.", + "description": "The instance ID.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/DescribeDBInstances.json b/en-US/dds/DescribeDBInstances.json index fdacdc5c3..ec5fe553d 100644 --- a/en-US/dds/DescribeDBInstances.json +++ b/en-US/dds/DescribeDBInstances.json @@ -70,7 +70,7 @@ }, { "name": "EngineVersion", - "description": "The database engine version of the instance. Valid values:\n\n* **5.0**\n* **4.4**\n* **4.2**\n* **4.0**\n* **3.4**", + "description": "The database engine version of the instance.\n\n* **6.0**\n* **5.0**\n* **4.4**\n* **4.2**\n* **4.0**\n* **3.4**", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/DescribeErrorLogRecords.json b/en-US/dds/DescribeErrorLogRecords.json index c73101ac0..29bc4bfb6 100644 --- a/en-US/dds/DescribeErrorLogRecords.json +++ b/en-US/dds/DescribeErrorLogRecords.json @@ -26,6 +26,13 @@ "type": "String", "required": true }, + { + "name": "LogicalOperator", + "description": "The logical relationship between multiple keywords. Valid values:\n\n* **or**\n* **and** (default value)", + "position": "Query", + "type": "String", + "required": false + }, { "name": "NodeId", "description": "The ID of the mongos node or shard node whose error logs you want to query in the instance. If the instance is a sharded cluster instance, you must specify this parameter.\n\n> This parameter is valid only when **DBInstanceId** is set to the ID of a sharded cluster instance.", @@ -47,6 +54,13 @@ "type": "Integer", "required": false }, + { + "name": "QueryKeywords", + "description": "The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces.", + "position": "Query", + "type": "String", + "required": false + }, { "name": "ResourceGroupId", "description": "The ID of the resource group. For more information, see [View basic information of a resource group](~~151181~~).", diff --git a/en-US/dds/DescribeMongoDBLogConfig.json b/en-US/dds/DescribeMongoDBLogConfig.json index 82d3c5c60..9929423f9 100644 --- a/en-US/dds/DescribeMongoDBLogConfig.json +++ b/en-US/dds/DescribeMongoDBLogConfig.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "DBInstanceId", - "description": "The ID of the instance. You can call the [DescribeDBInstances](~~61939~~) operation to query the ID of the instance.", + "description": "The instance ID. You can call the [DescribeDBInstances](~~61939~~) operation to query the ID of the instance.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/DescribeParameterModificationHistory.json b/en-US/dds/DescribeParameterModificationHistory.json index be41e9257..7381c8677 100644 --- a/en-US/dds/DescribeParameterModificationHistory.json +++ b/en-US/dds/DescribeParameterModificationHistory.json @@ -14,28 +14,28 @@ }, { "name": "DBInstanceId", - "description": "The ID of the instance.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.", + "description": "The instance ID.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.", "position": "Query", "type": "String", "required": true }, { "name": "EndTime", - "description": "The end of the time range to query. The end time must be later than the start time. Specify the time in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time must be in UTC.", + "description": "The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.", "position": "Query", "type": "String", "required": true }, { "name": "NodeId", - "description": "The ID of the mongos node or shard node whose parameter modification records you want to query in the instance. If the instance is a sharded cluster instance, you must specify this parameter.\n\n> This parameter is valid only when **DBInstanceId** is set to the ID of a sharded cluster instance.", + "description": "The ID of the mongos node or shard node whose parameter modification records you want to query in the instance.\n\n> This parameter is valid only when **DBInstanceId** is set to the ID of a sharded cluster instance.", "position": "Query", "type": "String", "required": false }, { "name": "StartTime", - "description": "The beginning of the time range to query. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.", + "description": "The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/DescribeParameterTemplates.json b/en-US/dds/DescribeParameterTemplates.json index 85ec3295f..4d6480400 100644 --- a/en-US/dds/DescribeParameterTemplates.json +++ b/en-US/dds/DescribeParameterTemplates.json @@ -24,6 +24,13 @@ "position": "Query", "type": "String", "required": false + }, + { + "name": "Role", + "description": "The role of the instance. Valid values:\n\n1. db: a shard node.\n\n1. cs: a Configserver node.\n\n1. mongos: a mongos node.\n\n1. normal: a replica set node.\n\n1. physical: a standalone node.\n\ndefault: normal", + "position": "Query", + "type": "String", + "required": false } ] } \ No newline at end of file diff --git a/en-US/dds/DescribeParameters.json b/en-US/dds/DescribeParameters.json index aff2f9bbd..8131a40e8 100644 --- a/en-US/dds/DescribeParameters.json +++ b/en-US/dds/DescribeParameters.json @@ -27,7 +27,7 @@ }, { "name": "NodeId", - "description": "The ID of the mongos or shard node in the specified sharded cluster instance.\n\n> This parameter is valid only when you specify the **DBInstanceId** parameter to the ID of a sharded cluster instance.", + "description": "The ID of the mongos or shard node in the specified sharded cluster instance.\n\n> This parameter is valid when the **DBInstanceId** parameter is set to the ID of a sharded cluster instance.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/DescribeRunningLogRecords.json b/en-US/dds/DescribeRunningLogRecords.json index 1903814ad..10f368c0b 100644 --- a/en-US/dds/DescribeRunningLogRecords.json +++ b/en-US/dds/DescribeRunningLogRecords.json @@ -26,6 +26,13 @@ "type": "String", "required": true }, + { + "name": "LogicalOperator", + "description": "The logical relationship among multiple keywords.\n\n* **or**\n* **and** (default value)", + "position": "Query", + "type": "String", + "required": false + }, { "name": "NodeId", "description": "The ID of the mongos node or shard node whose operational logs you want to query in the instance. If the instance is a sharded cluster instance, you must specify this parameter.\n\n> This parameter is valid only when **DBInstanceId** is set to the ID of a sharded cluster instance.", @@ -54,6 +61,13 @@ "type": "Integer", "required": false }, + { + "name": "QueryKeywords", + "description": "The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces.", + "position": "Query", + "type": "String", + "required": false + }, { "name": "ResourceGroupId", "description": "The ID of the resource group.", diff --git a/en-US/dds/DescribeSecurityIps.json b/en-US/dds/DescribeSecurityIps.json index 93838928e..706da1a85 100644 --- a/en-US/dds/DescribeSecurityIps.json +++ b/en-US/dds/DescribeSecurityIps.json @@ -11,6 +11,13 @@ "position": "Query", "type": "String", "required": true + }, + { + "name": "ShowHDMIps", + "description": "Whether to display DAS whitelist information.", + "position": "Query", + "type": "Boolean", + "required": false } ] } \ No newline at end of file diff --git a/en-US/dds/DescribeShardingNetworkAddress.json b/en-US/dds/DescribeShardingNetworkAddress.json index 56cee243b..3822dcb46 100644 --- a/en-US/dds/DescribeShardingNetworkAddress.json +++ b/en-US/dds/DescribeShardingNetworkAddress.json @@ -6,14 +6,14 @@ "parameters": [ { "name": "DBInstanceId", - "description": "The ID of an instance.", + "description": "The instance ID.", "position": "Query", "type": "String", "required": true }, { "name": "NodeId", - "description": "A sharded cluster instance consists of three components: mongos, shard, and Configserver.\n\n> You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the ID of the mongos, shard, or Configserverr node.", + "description": "The ID of the mongos, shard, or Configserver node in the sharded cluster instance.\n\n> You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the ID of the mongos, shard, or Configserver node.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/DescribeSlowLogRecords.json b/en-US/dds/DescribeSlowLogRecords.json index d53023b11..3a237d9c7 100644 --- a/en-US/dds/DescribeSlowLogRecords.json +++ b/en-US/dds/DescribeSlowLogRecords.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "DBInstanceId", - "description": "The ID of the instance.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the `NodeId` parameter.", + "description": "The instance ID.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the `NodeId` parameter.", "position": "Query", "type": "String", "required": true @@ -21,11 +21,18 @@ }, { "name": "EndTime", - "description": "The end of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.\n\n> \n\n* The end time must be later than the start time.\n\n* The end time must be within 24 hours from the start time. Otherwise, the query fails.", + "description": "The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.\n\n> \n\n* The end time must be later than the start time.\n\n* The end time must be within 24 hours from the start time. Otherwise, the query fails.", "position": "Query", "type": "String", "required": true }, + { + "name": "LogicalOperator", + "description": "The logical relationship among multiple keywords.\n\n* **or**\n* **and** (default value)", + "position": "Query", + "type": "String", + "required": false + }, { "name": "NodeId", "description": "The ID of the shard node.\n\n> This parameter is required only when you specify the `DBInstanceId` parameter to the ID of a sharded cluster instance.", @@ -42,7 +49,7 @@ }, { "name": "PageNumber", - "description": "The number of the page to return. The value of this parameter must be an integer that is greater than 0. Default value: **1**.", + "description": "The page number of the page to return. The value must be a positive integer that does not exceed the maximum value of the INTEGER data type. Default value: **1**.", "position": "Query", "type": "Integer", "required": false @@ -54,16 +61,23 @@ "type": "Integer", "required": false }, + { + "name": "QueryKeywords", + "description": "The keywords used for query. You can enter up to 10 keywords at a time. If you enter multiple keywords, separate the keywords with spaces.", + "position": "Query", + "type": "String", + "required": false + }, { "name": "ResourceGroupId", - "description": "The ID of the resource group.", + "description": "The ID of the resource group to which the instances you want to query belong.", "position": "Query", "type": "String", "required": false }, { "name": "StartTime", - "description": "The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.", + "description": "The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/ModifyAccountDescription.json b/en-US/dds/ModifyAccountDescription.json index a1052563b..918f029eb 100644 --- a/en-US/dds/ModifyAccountDescription.json +++ b/en-US/dds/ModifyAccountDescription.json @@ -21,7 +21,7 @@ }, { "name": "DBInstanceId", - "description": "The ID of the instance.", + "description": "The instance ID.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/ModifyAuditLogFilter.json b/en-US/dds/ModifyAuditLogFilter.json index ea6a08e1e..1ec3c2273 100644 --- a/en-US/dds/ModifyAuditLogFilter.json +++ b/en-US/dds/ModifyAuditLogFilter.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "DBInstanceId", - "description": "The ID of the instance.", + "description": "The instance ID.", "position": "Query", "type": "String", "required": true }, { "name": "Filter", - "description": "The type of the audit log entries to be collected. Valid values:\n\n* **admin**: O\\&M and management operations\n* **slow**: slow query logs\n* **query**: query operations\n* **insert**: insert operations\n* **update**: update operations\n* **delete**: delete operations\n* **command**: protocol commands such as the aggregate method", + "description": "The type of logs collected by the audit log feature of the instance. Separate multiple types with commas (,). Valid values:\n\n* **admin**: O\\&M and management operations\n* **slow**: slow query logs\n* **query**: query operations\n* **insert**: insert operations\n* **update**: update operations\n* **delete**: delete operations\n* **command**: protocol commands such as the aggregate method", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/ModifyAuditPolicy.json b/en-US/dds/ModifyAuditPolicy.json index 9ebfa2f85..7b0c932e6 100644 --- a/en-US/dds/ModifyAuditPolicy.json +++ b/en-US/dds/ModifyAuditPolicy.json @@ -28,7 +28,7 @@ }, { "name": "ServiceType", - "description": "The type of the audit log feature. Valid values:\n\n* **Trail**: the free trial edition\n* **Standard**: the official edition\n\n> Default value: **Trial**. Starting from January 6, 2022, the official edition of the audit log feature has been launched in all regions, and new applications for the free trial edition have ended. We recommend that you set this parameter to **Standard**.", + "description": "The type of the audit log feature. Valid values:\n\n* **Trial**: the free trial edition\n* **Standard**: the official edition\n\n> Default value: **Trial**. Starting from January 6, 2022, the official edition of the audit log feature has been launched in all regions, and new applications for the free trial edition have ended. We recommend that you set this parameter to **Standard**.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/ModifyDBInstanceConnectionString.json b/en-US/dds/ModifyDBInstanceConnectionString.json index 5c9d58a76..fae6f7ee4 100644 --- a/en-US/dds/ModifyDBInstanceConnectionString.json +++ b/en-US/dds/ModifyDBInstanceConnectionString.json @@ -28,7 +28,7 @@ }, { "name": "NewPort", - "description": "this parameter can be used. The new port should be within the range of 1000 to 65535.\n>When the DBInstanceId parameter is passed in as a cloud disk instance ID", + "description": "The new port. The new port ranges from 1000 to 65535.\n>This parameter is available only when the DBInstanceId parameter is set to a cloud-disk instance ID.", "position": "Query", "type": "Integer", "required": false diff --git a/en-US/dds/ModifyDBInstanceDescription.json b/en-US/dds/ModifyDBInstanceDescription.json index 73500a3ee..48e6663d2 100644 --- a/en-US/dds/ModifyDBInstanceDescription.json +++ b/en-US/dds/ModifyDBInstanceDescription.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "DBInstanceDescription", - "description": "The name of the instance.\n\n> \n\n* The name cannot start with `http://` or `https://`.\n\n* The name must start with a letter.\n\n* The name must be 2 to 256 characters in length, and can contain letters, underscores (\\_), hyphens (-), and digits.", + "description": "The name of the instance.\n\n> \n\n* The name cannot start with `http://` or `https://`.\n\n* It must start with a letter.\n\n* It must be 2 to 256 characters in length, and can contain letters, underscores (\\_), hyphens (-), and digits.", "position": "Query", "type": "String", "required": true }, { "name": "DBInstanceId", - "description": "The ID of the instance\n\n> To modify the name of a shard or mongos node in a sharded cluster instance, you must also specify the **NodeId** parameter.", + "description": "The instance ID.\n\n> To modify the name of a shard or mongos node in a sharded cluster instance, you must also specify the **NodeId** parameter.", "position": "Query", "type": "String", "required": true }, { "name": "NodeId", - "description": "The ID of the shard or mongos node in the sharded cluster instance.\n\n> This parameter is valid only if you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.", + "description": "The ID of the shard or mongos node in the sharded cluster instance.\n\n> This parameter is valid only if you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/ModifyDBInstanceMaintainTime.json b/en-US/dds/ModifyDBInstanceMaintainTime.json index aa19e9b9b..bd9d0d4fc 100644 --- a/en-US/dds/ModifyDBInstanceMaintainTime.json +++ b/en-US/dds/ModifyDBInstanceMaintainTime.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "DBInstanceId", - "description": "The ID of the instance.", + "description": "The instance ID.", "position": "Query", "type": "String", "required": true }, { "name": "MaintainEndTime", - "description": "The end time of the maintenance window. Specify the time in the *HH:mmZ* format. The time must be in UTC.\n\n> The end time must be later than the start time of the maintenance window.", + "description": "The end time of the maintenance window. Specify the time in the ISO 8601 standard in the *HH:mm*Z format. The time must be in UTC.\n\n> The end time must be later than the start time of the maintenance window.", "position": "Query", "type": "String", "required": true }, { "name": "MaintainStartTime", - "description": "The start time of the maintenance window. Specify the time in the *HH:mm*Z format. The time must be in UTC.", + "description": "The start time of the maintenance window. Specify the time in the ISO 8601 standard in the *HH:mm*Z format. The time must be in UTC.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/ModifyDBInstanceNetExpireTime.json b/en-US/dds/ModifyDBInstanceNetExpireTime.json index 70d950da9..72a2a0d1b 100644 --- a/en-US/dds/ModifyDBInstanceNetExpireTime.json +++ b/en-US/dds/ModifyDBInstanceNetExpireTime.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "ClassicExpendExpiredDays", - "description": "The retention period of the original classic network address. Valid values: **14**, **30**, **60**, and** 120**. Unit: day.", + "description": "The retention period of the classic network endpoint of the instance. Valid values: **14**, **30**, **60**, and **120**. Unit: day.", "position": "Query", "type": "Integer", "required": true }, { "name": "ConnectionString", - "description": "The connection string of the instance", + "description": "The endpoint of the instance.", "position": "Query", "type": "String", "required": false }, { "name": "DBInstanceId", - "description": "The ID of the instance.", + "description": "The instance ID.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/ModifyDBInstanceSSL.json b/en-US/dds/ModifyDBInstanceSSL.json index 34b10e0fd..bd8cf7c0c 100644 --- a/en-US/dds/ModifyDBInstanceSSL.json +++ b/en-US/dds/ModifyDBInstanceSSL.json @@ -14,7 +14,7 @@ }, { "name": "SSLAction", - "description": "The operation on the SSL feature. Valid values: Valid values:\n\n* **Open**: enables SSL encryption.\n* **Close**: disables SSL encryption.\n* **Update**: updates the SSL certificate.", + "description": "The operation on the SSL feature. Valid values:\n\n* **Open**: enables SSL encryption.\n* **Close**: disables SSL encryption.\n* **Update**: updates the SSL certificate.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/ModifyDBInstanceTDE.json b/en-US/dds/ModifyDBInstanceTDE.json index 7f86a3bd3..874f7050c 100644 --- a/en-US/dds/ModifyDBInstanceTDE.json +++ b/en-US/dds/ModifyDBInstanceTDE.json @@ -27,7 +27,7 @@ }, { "name": "RoleARN", - "description": "The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role. The ARN is displayed in the `acs:ram::$accountID:role/$roleName` format.\n\n> \n\n* `$accountID`: specifies the ID of the Alibaba Cloud account. To view the account ID, log on to the Alibaba Cloud Management Console, move your pointer over your profile picture in the upper-right corner, and then click Security Settings.\n\n* `$roleName`: specifies the name of the RAM role. To view the RAM role name, log on to the RAM console. In the left-side navigation pane, choose Identities > Roles. On the Roles page, view the name of the RAM role.", + "description": "The Alibaba Cloud Resource Name (ARN) of the specified Resource Access Management (RAM) role. The ARN is displayed in the `acs:ram::$accountID:role/$roleName` format.\n\n> * `$accountID`: specifies the ID of the Alibaba Cloud account. To view the account ID, log on to the Alibaba Cloud Management Console, move your pointer over your profile picture in the upper-right corner, and then click Security Settings.\n\n> * `$roleName`: specifies the name of the RAM role. To view the RAM role name, log on to the RAM console. In the left-side navigation pane, choose Identities > Roles. On the Roles page, view the name of the RAM role.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/ModifyInstanceVpcAuthMode.json b/en-US/dds/ModifyInstanceVpcAuthMode.json index e66f532a8..167e9cde3 100644 --- a/en-US/dds/ModifyInstanceVpcAuthMode.json +++ b/en-US/dds/ModifyInstanceVpcAuthMode.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "DBInstanceId", - "description": "The ID of the instance.", + "description": "The instance ID.", "position": "Query", "type": "String", "required": true }, { "name": "NodeId", - "description": "The ID of the mongos node in the specified sharded cluster instance.\n\n> This parameter can be used only when the instance type is sharded cluster.", + "description": "The ID of the mongos node in the sharded cluster instance.\n\n> This parameter can be used only when the instance type is sharded cluster.", "position": "Query", "type": "String", "required": false }, { "name": "VpcAuthMode", - "description": "Specifies whether to enable authentication to allow access within a VPC. Valid values:\n\n* **Open**: enables password-free access.\n* **Close**: disables password-free access.", + "description": "Specify whether to disable password-free access over VPC. Set the value to **Close**.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/ModifyNodeSpec.json b/en-US/dds/ModifyNodeSpec.json index c39228cfc..71ef7e77e 100644 --- a/en-US/dds/ModifyNodeSpec.json +++ b/en-US/dds/ModifyNodeSpec.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "AutoPay", - "description": "Specifies whether to enable automatic payment. Default value: true. Valid values:\n\n* **true**: enables automatic payment. Make sure that you have sufficient balance within your account.\n* **false**: disables automatic payment.", + "description": "Specifies whether to enable automatic payment. Valid values:\n\n* **true** (default): enables automatic payment. Make sure that you have sufficient balance within your account.\n* **false**: disables automatic payment. In this case, you must manually pay for the instance.", "position": "Query", "type": "Boolean", "required": false @@ -42,7 +42,7 @@ }, { "name": "EffectiveTime", - "description": "The time when the changed configurations take effect. Default value: Immediately. Valid values:\n\n* **Immediately**: The new configurations immediately take effect.\n* **MaintainTime**: The new configurations take effect during the maintenance window of the instance.", + "description": "The time when the changed configurations take effect. Valid values:\n\n* **Immediately** (default): The new configurations immediately take effect\n* **MaintainTime**: The new configurations take effect during the maintenance window of the instance.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/ModifyParameters.json b/en-US/dds/ModifyParameters.json index e582a7e85..883c93f4b 100644 --- a/en-US/dds/ModifyParameters.json +++ b/en-US/dds/ModifyParameters.json @@ -6,14 +6,14 @@ "parameters": [ { "name": "CharacterType", - "description": "The role of the instance. Valid values:\n\n* **db**: a shard node\n* **cs**: a Configserver node\n* **mongos**: a mongos node\n* **logic**: a sharded cluster instance", + "description": "The role of the instance. Valid values:\n\n* **db**: a shard node.\n* **cs**: a Configserver node.\n* **mongos**: a mongos node.", "position": "Query", "type": "String", "required": false }, { "name": "DBInstanceId", - "description": "The ID of the instance.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.", + "description": "The instance ID.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the NodeId parameter.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/ReleaseNodePrivateNetworkAddress.json b/en-US/dds/ReleaseNodePrivateNetworkAddress.json index 2a803dba9..38dd76b87 100644 --- a/en-US/dds/ReleaseNodePrivateNetworkAddress.json +++ b/en-US/dds/ReleaseNodePrivateNetworkAddress.json @@ -13,7 +13,7 @@ }, { "name": "NetworkType", - "description": "The network type of the internal endpoint. Valid values:\n\n* **VPC**\n* **Classic**\n\n> You can call the [DescribeShardingNetworkAddress](~~62135~~) operation to query the network type of the internal endpoint.", + "description": "The network type of the internal endpoint. Valid values:\n\n* **VPC**: virtual private cloud (VPC).\n* **Classic**: classic network.\n\n> You can call the [DescribeShardingNetworkAddress](~~62135~~) operation to query the network type of the internal endpoint.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/ReleasePublicNetworkAddress.json b/en-US/dds/ReleasePublicNetworkAddress.json index a38678f96..52b814ed1 100644 --- a/en-US/dds/ReleasePublicNetworkAddress.json +++ b/en-US/dds/ReleasePublicNetworkAddress.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "DBInstanceId", - "description": "The ID of the instance.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.", + "description": "The instance ID.\n\n> If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.", "position": "Query", "type": "String", "required": true }, { "name": "NodeId", - "description": "A sharded cluster instance consists of three components: mongos, shard, and Configserver.\n\n> * This parameter is valid only if you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.\n> * You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to query the ID of the mongos, shard, or Configserver node.", + "description": "The ID of the mongos, shard, or Configserver node in the sharded cluster instance.\n\n> * This parameter is valid only if you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.\n> * You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the ID of the mongos, shard, or Configserver node.", "position": "Query", "type": "String", "required": false diff --git a/en-US/dds/RestoreDBInstance.json b/en-US/dds/RestoreDBInstance.json index 515aec643..145d793c1 100644 --- a/en-US/dds/RestoreDBInstance.json +++ b/en-US/dds/RestoreDBInstance.json @@ -14,7 +14,7 @@ }, { "name": "DBInstanceId", - "description": "The ID of an instance.", + "description": "The instance ID.", "position": "Query", "type": "String", "required": true diff --git a/en-US/dds/TransformToPrePaid.json b/en-US/dds/TransformToPrePaid.json index 57fed30fd..9d34da898 100644 --- a/en-US/dds/TransformToPrePaid.json +++ b/en-US/dds/TransformToPrePaid.json @@ -42,7 +42,7 @@ }, { "name": "Period", - "description": "The subscription duration of the instance. Unit: months. Valid values: **1, 2, 3, 4, 5, 6, 7, 8, 9******, **12**, **24**, and **36**.", + "description": "The subscription duration of the instance. Unit: months. Valid values: **1**, **2**, **3**, **4**, **5**, **6**, **7**, **8**, **9**, **12**, **24**, and **36**.", "position": "Query", "type": "Long", "required": true diff --git a/en-US/dds/version.json b/en-US/dds/version.json index fe89f4802..87f989620 100644 --- a/en-US/dds/version.json +++ b/en-US/dds/version.json @@ -4,7 +4,7 @@ "apis": { "AllocateNodePrivateNetworkAddress": { "title": "AllocateNodePrivateNetworkAddress", - "summary": "Applies for an internal endpoint for a shard or Configserver node of an ApsaraDB for MongoDB sharded cluster instance.", + "summary": "Applies for an internal endpoint for a shard or Configserver node in an ApsaraDB for MongoDB sharded cluster instance.", "deprecated": false }, "AllocatePublicNetworkAddress": { @@ -19,7 +19,7 @@ }, "CheckRecoveryCondition": { "title": "CheckRecoveryCondition", - "summary": "You can call this operation to check whether an ApsaraDB for MongoDB instance meets the data recovery conditions.", + "summary": "Queries whether the data of an ApsaraDB for MongoDB instance can be restored.", "deprecated": false }, "CreateAccount": { @@ -29,7 +29,7 @@ }, "CreateBackup": { "title": "CreateBackup", - "summary": "Manually backs up an ApsaraDB for MongoDB instance.", + "summary": "Creates a backup set for an ApsaraDB for MongoDB instance.", "deprecated": false }, "CreateDBInstance": { @@ -44,7 +44,7 @@ }, "CreateNodeBatch": { "title": "CreateNodeBatch", - "summary": "Adds mongos or shard nodes for ApsaraDB for MongoDB sharded cluster instances in batches.", + "summary": "The password of the account. The password must meet the following requirements:\n\n\\* The password contains at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.\n\\* Special characters include ! @ # $ % ^ & \\\\* ( ) \\\\_ + - =\n\\* The password of the account must be 8 to 32 characters in length.\n\n\\> If you apply for an endpoint for a shard node, the password cannot be changed.", "deprecated": false }, "CreateShardingDBInstance": { @@ -59,7 +59,7 @@ }, "DeleteNode": { "title": "DeleteNode", - "summary": "You can call this operation to delete a shard or mongos node in a sharded cluster instance.", + "summary": "Deletes a shard or mongos node from an ApsaraDB for MongoDB sharded cluster instance.", "deprecated": false }, "DescribeAccounts": { @@ -69,17 +69,17 @@ }, "DescribeActiveOperationTaskCount": { "title": "DescribeActiveOperationTaskCount", - "summary": "You can call this operation to query the number of O\\&M tasks on an ApsaraDB for MongoDB instance.", + "summary": "Queries the number of O\\\\\\&M tasks on an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeActiveOperationTaskType": { "title": "DescribeActiveOperationTaskType", - "summary": "Queries the types of O\\\\\\\\\\\\&M tasks on an ApsaraDB for MongoDB instance and the number and details of tasks of each type.", + "summary": "Queries the types of Operation and Maintenance tasks and the number of tasks of each type for an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeActiveOperationTasks": { "title": "DescribeActiveOperationTasks", - "summary": "", + "summary": "Queries a list of O\\&M tasks for an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeAuditLogFilter": { @@ -114,7 +114,7 @@ }, "DescribeBackupDBs": { "title": "DescribeBackupDBs", - "summary": "Queries the databases at a specified time or contained in a specified backup set before restoring a database for an ApsaraDB for MongoDB instance.", + "summary": "Queries the databases at a specified time or the databases in a specified backup set before you restore a database for an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeBackupPolicy": { @@ -139,7 +139,7 @@ }, "DescribeDBInstanceAttribute": { "title": "DescribeDBInstanceAttribute", - "summary": "Queries the information of ApsaraDB for MongoDB instances.", + "summary": "Queries the details of an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeDBInstanceEncryptionKey": { @@ -149,12 +149,12 @@ }, "DescribeDBInstanceMonitor": { "title": "DescribeDBInstanceMonitor", - "summary": "You can call this operation to query the collection frequency of monitoring data for an ApsaraDB for MongoDB instance.", + "summary": "Queries the collection frequency of monitoring data for an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeDBInstancePerformance": { "title": "DescribeDBInstancePerformance", - "summary": "Queries the performance metric data of an ApsaraDB for MongoDB instance.", + "summary": "Queries the performance data of an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeDBInstanceSSL": { @@ -169,7 +169,7 @@ }, "DescribeDBInstanceTDEInfo": { "title": "DescribeDBInstanceTDEInfo", - "summary": "Queries whether transparent data encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.", + "summary": "Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeDBInstances": { @@ -204,7 +204,7 @@ }, "DescribeKernelReleaseNotes": { "title": "DescribeKernelReleaseNotes", - "summary": "You can call this operation to query the release notes of the minor database versions of a MongoDB instance.", + "summary": "Queries the release notes of the minor versions of an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeKmsKeys": { @@ -214,7 +214,7 @@ }, "DescribeMongoDBLogConfig": { "title": "DescribeMongoDBLogConfig", - "summary": "Queries the audit log feature configurations of an ApsaraDB for MongoDB instance.", + "summary": "Queries the logging configurations of an ApsaraDB for MongoDB instance.", "deprecated": false }, "DescribeParameterModificationHistory": { @@ -274,7 +274,7 @@ }, "DescribeShardingNetworkAddress": { "title": "DescribeShardingNetworkAddress", - "summary": "You can call this operation to query the connection information of sharded cluster instances of ApsaraDB for MongoDB.", + "summary": "Queries connection information about an ApsaraDB for MongoDB sharded cluster instance.", "deprecated": false }, "DescribeSlowLogRecords": { @@ -329,7 +329,7 @@ }, "ModifyAuditPolicy": { "title": "ModifyAuditPolicy", - "summary": "Enables or disables the audit log feature or sets the log retention period for an ApsaraDB for MongoDB instance.", + "summary": "Enables or disables the audit log feature or configures the log storage duration for an ApsaraDB for MongoDB instance.", "deprecated": false }, "ModifyBackupPolicy": { @@ -339,7 +339,7 @@ }, "ModifyDBInstanceConnectionString": { "title": "ModifyDBInstanceConnectionString", - "summary": "You can call this operation to modify the connection string of a MongoDB instance.", + "summary": "Modifies the endpoint that is used to connect to an ApsaraDB for MongoDB instance.", "deprecated": false }, "ModifyDBInstanceDescription": { @@ -354,12 +354,12 @@ }, "ModifyDBInstanceMonitor": { "title": "ModifyDBInstanceMonitor", - "summary": "You can call this operation to set the monitoring granularity for a ApsaraDB for MongoDB instance.", + "summary": "You can call this operation to set the monitoring granularity for an ApsaraDB for MongoDB instance.", "deprecated": false }, "ModifyDBInstanceNetExpireTime": { "title": "ModifyDBInstanceNetExpireTime", - "summary": "You can call this operation to extend the retention period of the classic network of a MongoDB instance.", + "summary": "Extends the retention period of the classic network endpoint of an ApsaraDB for MongoDB instance.", "deprecated": false }, "ModifyDBInstanceNetworkType": { @@ -379,7 +379,7 @@ }, "ModifyDBInstanceTDE": { "title": "ModifyDBInstanceTDE", - "summary": "Modifies the Transparent Data Encryption (TDE) status of an ApsaraDB for MongoDB instance.", + "summary": "Modifies the transparent data encryption (TDE) status of an ApsaraDB for MongoDB instance.", "deprecated": false }, "ModifyInstanceAutoRenewalAttribute": { @@ -389,7 +389,7 @@ }, "ModifyInstanceVpcAuthMode": { "title": "ModifyInstanceVpcAuthMode", - "summary": "You can call this operation to enable or disable password-free access from the same VPC as an ApsaraDB for MongoDB instance.", + "summary": "Disables password-free access over Virtual Private Cloud (VPC) for an ApsaraDB for MongoDB instance.", "deprecated": false }, "ModifyNodeSpec": { @@ -399,7 +399,7 @@ }, "ModifyNodeSpecBatch": { "title": "ModifyNodeSpecBatch", - "summary": "Modifies the configurations of one or more mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.", + "summary": "Changes the configurations of mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.", "deprecated": false }, "ModifyParameters": { @@ -419,21 +419,22 @@ }, "ModifySecurityIps": { "title": "ModifySecurityIps", - "summary": "You can call this operation to modify the IP address whitelist of an ApsaraDB for MongoDB instance.", + "summary": "Modifies the IP address whitelist of an ApsaraDB for MongoDB instance.", "deprecated": false }, "ModifyTaskInfo": { "title": "ModifyTaskInfo", + "summary": "Modifies the information of a task in the task center for an ApsaraDB for MongoDB instance.", "deprecated": false }, "ReleaseNodePrivateNetworkAddress": { "title": "ReleaseNodePrivateNetworkAddress", - "summary": "Releases the internal endpoint of the shard or Configserver node of a sharded cluster instance.", + "summary": "Releases the internal endpoint of a shard or Configserver node in a sharded cluster instance.", "deprecated": false }, "ReleasePublicNetworkAddress": { "title": "ReleasePublicNetworkAddress", - "summary": "You can call this operation to release the public endpoint of an ApsaraDB for MongoDB instance.", + "summary": "Releases the public endpoint of an ApsaraDB for MongoDB instance.", "deprecated": false }, "RenewDBInstance": { @@ -443,7 +444,7 @@ }, "ResetAccountPassword": { "title": "ResetAccountPassword", - "summary": "You can call this operation to reset the password of the root account of an ApsaraDB for MongoDB instance.", + "summary": "Resets the password of the root account in an ApsaraDB for MongoDB instance.", "deprecated": false }, "RestartDBInstance": { @@ -453,7 +454,7 @@ }, "RestoreDBInstance": { "title": "RestoreDBInstance", - "summary": "You can call this operation to restore data to the current ApsaraDB for MongoDB instance.", + "summary": "Restores data to an ApsaraDB for MongoDB instance.", "deprecated": false }, "SwitchDBInstanceHA": { @@ -463,7 +464,7 @@ }, "TagResources": { "title": "TagResources", - "summary": "You can call this operation to bind tags to one or more ApsaraDB for MongoDB instances.", + "summary": "Binds tags to ApsaraDB for MongoDB instances.", "deprecated": false }, "TransferClusterBackup": { diff --git a/en-US/devops/CreateAppMembers.json b/en-US/devops/CreateAppMembers.json new file mode 100644 index 000000000..2841f0991 --- /dev/null +++ b/en-US/devops/CreateAppMembers.json @@ -0,0 +1,29 @@ +{ + "name": "CreateAppMembers", + "protocol": "HTTP|HTTPS", + "method": "POST", + "pathPattern": "/appstack/apps/[appName]/members", + "parameters": [ + { + "name": "appName", + "description": "", + "position": "Path", + "type": "String", + "required": false + }, + { + "name": "body", + "description": "", + "position": "Body", + "type": "String", + "required": false + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/devops/CreateProjectLabel.json b/en-US/devops/CreateProjectLabel.json new file mode 100644 index 000000000..8f436d1de --- /dev/null +++ b/en-US/devops/CreateProjectLabel.json @@ -0,0 +1,37 @@ +{ + "name": "CreateProjectLabel", + "deprecated": false, + "protocol": "HTTPS", + "method": "POST", + "pathPattern": "/api/v4/projects/labels", + "parameters": [ + { + "name": "accessToken", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "body", + "description": "", + "position": "Body", + "type": "String", + "required": false + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "repositoryIdentity", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/devops/DeleteAppMember.json b/en-US/devops/DeleteAppMember.json new file mode 100644 index 000000000..7b7a052ea --- /dev/null +++ b/en-US/devops/DeleteAppMember.json @@ -0,0 +1,37 @@ +{ + "name": "DeleteAppMember", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "DELETE", + "pathPattern": "/appstack/apps/[appName]/members", + "parameters": [ + { + "name": "appName", + "description": "", + "position": "Path", + "type": "String", + "required": false + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "subjectId", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "subjectType", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/devops/DeleteProjectLabel.json b/en-US/devops/DeleteProjectLabel.json new file mode 100644 index 000000000..730905581 --- /dev/null +++ b/en-US/devops/DeleteProjectLabel.json @@ -0,0 +1,37 @@ +{ + "name": "DeleteProjectLabel", + "deprecated": false, + "protocol": "HTTPS", + "method": "DELETE", + "pathPattern": "/api/v4/projects/labels/[labelId]", + "parameters": [ + { + "name": "accessToken", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "labelId", + "description": "", + "position": "Path", + "type": "String", + "required": true + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "repositoryIdentity", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/devops/GetApplication.json b/en-US/devops/GetApplication.json new file mode 100644 index 000000000..da65bc049 --- /dev/null +++ b/en-US/devops/GetApplication.json @@ -0,0 +1,23 @@ +{ + "name": "GetApplication", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET", + "pathPattern": "/appstack/apps/[appName]", + "parameters": [ + { + "name": "appName", + "description": "", + "position": "Path", + "type": "String", + "required": false + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/devops/GetWorkitemFile.json b/en-US/devops/GetWorkitemFile.json new file mode 100644 index 000000000..f43663b4a --- /dev/null +++ b/en-US/devops/GetWorkitemFile.json @@ -0,0 +1,30 @@ +{ + "name": "GetWorkitemFile", + "deprecated": false, + "protocol": "HTTPS", + "method": "GET", + "pathPattern": "/organization/[organizationId]/workitem/[workitemIdentifier]/files/[fileIdentifier]", + "parameters": [ + { + "name": "fileIdentifier", + "description": "", + "position": "Path", + "type": "String", + "required": true + }, + { + "name": "organizationId", + "description": "", + "position": "Path", + "type": "String", + "required": true + }, + { + "name": "workitemIdentifier", + "description": "", + "position": "Path", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/devops/LinkMergeRequestLabel.json b/en-US/devops/LinkMergeRequestLabel.json new file mode 100644 index 000000000..6cb75d851 --- /dev/null +++ b/en-US/devops/LinkMergeRequestLabel.json @@ -0,0 +1,44 @@ +{ + "name": "LinkMergeRequestLabel", + "deprecated": false, + "protocol": "HTTPS", + "method": "POST", + "pathPattern": "/api/v4/projects/merge_requests/link_labels", + "parameters": [ + { + "name": "accessToken", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "body", + "description": "", + "position": "Body", + "type": "String", + "required": false + }, + { + "name": "localId", + "description": "", + "position": "Query", + "type": "Long", + "required": true + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "repositoryIdentity", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/devops/ListApplicationMembers.json b/en-US/devops/ListApplicationMembers.json new file mode 100644 index 000000000..486c6eea4 --- /dev/null +++ b/en-US/devops/ListApplicationMembers.json @@ -0,0 +1,23 @@ +{ + "name": "ListApplicationMembers", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET", + "pathPattern": "/appstack/apps/[appName]/members", + "parameters": [ + { + "name": "appName", + "description": "", + "position": "Path", + "type": "String", + "required": false + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/devops/ListApplications.json b/en-US/devops/ListApplications.json new file mode 100644 index 000000000..249bb7024 --- /dev/null +++ b/en-US/devops/ListApplications.json @@ -0,0 +1,51 @@ +{ + "name": "ListApplications", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET", + "pathPattern": "/appstack/apps:search", + "parameters": [ + { + "name": "nextToken", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "orderBy", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "pagination", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "perPage", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, + { + "name": "sort", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/devops/ListMergeRequestLabels.json b/en-US/devops/ListMergeRequestLabels.json new file mode 100644 index 000000000..b172b0919 --- /dev/null +++ b/en-US/devops/ListMergeRequestLabels.json @@ -0,0 +1,37 @@ +{ + "name": "ListMergeRequestLabels", + "deprecated": false, + "protocol": "HTTPS", + "method": "GET", + "pathPattern": "/api/v4/projects/merge_requests/labels", + "parameters": [ + { + "name": "accessToken", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "localId", + "description": "", + "position": "Query", + "type": "Long", + "required": true + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "repositoryIdentity", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/devops/ListMergeRequests.json b/en-US/devops/ListMergeRequests.json index e8e322539..ba8286b0f 100644 --- a/en-US/devops/ListMergeRequests.json +++ b/en-US/devops/ListMergeRequests.json @@ -19,6 +19,20 @@ "type": "String", "required": false }, + { + "name": "createdAfter", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "createdBefore", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "filter", "description": "", @@ -33,6 +47,13 @@ "type": "String", "required": false }, + { + "name": "labelIds", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, { "name": "orderBy", "description": "", diff --git a/en-US/devops/ListProjectLabels.json b/en-US/devops/ListProjectLabels.json new file mode 100644 index 000000000..beef6a8bb --- /dev/null +++ b/en-US/devops/ListProjectLabels.json @@ -0,0 +1,72 @@ +{ + "name": "ListProjectLabels", + "deprecated": false, + "protocol": "HTTPS", + "method": "GET", + "pathPattern": "/api/v4/projects/labels", + "parameters": [ + { + "name": "accessToken", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "orderBy", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "page", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, + { + "name": "pageSize", + "description": "", + "position": "Query", + "type": "Long", + "required": false + }, + { + "name": "repositoryIdentity", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "search", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "sort", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "withCounts", + "description": "", + "position": "Query", + "type": "Boolean", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/devops/UpdateAppMember.json b/en-US/devops/UpdateAppMember.json new file mode 100644 index 000000000..8bb92485a --- /dev/null +++ b/en-US/devops/UpdateAppMember.json @@ -0,0 +1,30 @@ +{ + "name": "UpdateAppMember", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "PUT", + "pathPattern": "/appstack/apps/[appName]/members", + "parameters": [ + { + "name": "appName", + "description": "", + "position": "Path", + "type": "String", + "required": false + }, + { + "name": "body", + "description": "", + "position": "Body", + "type": "String", + "required": false + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/devops/UpdateApplication.json b/en-US/devops/UpdateApplication.json new file mode 100644 index 000000000..cf5d07695 --- /dev/null +++ b/en-US/devops/UpdateApplication.json @@ -0,0 +1,30 @@ +{ + "name": "UpdateApplication", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "PUT", + "pathPattern": "/appstack/apps/[appName]", + "parameters": [ + { + "name": "appName", + "description": "", + "position": "Path", + "type": "String", + "required": false + }, + { + "name": "body", + "description": "", + "position": "Body", + "type": "String", + "required": false + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/devops/UpdateProjectLabel.json b/en-US/devops/UpdateProjectLabel.json new file mode 100644 index 000000000..f448a91e7 --- /dev/null +++ b/en-US/devops/UpdateProjectLabel.json @@ -0,0 +1,44 @@ +{ + "name": "UpdateProjectLabel", + "deprecated": false, + "protocol": "HTTPS", + "method": "PUT", + "pathPattern": "/api/v4/projects/labels/[labelId]", + "parameters": [ + { + "name": "accessToken", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "body", + "description": "", + "position": "Body", + "type": "String", + "required": false + }, + { + "name": "labelId", + "description": "", + "position": "Path", + "type": "String", + "required": true + }, + { + "name": "organizationId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "repositoryIdentity", + "description": "", + "position": "Query", + "type": "String", + "required": true + } + ] +} \ No newline at end of file diff --git a/en-US/devops/version.json b/en-US/devops/version.json index 6fa62667b..06a9049fb 100644 --- a/en-US/devops/version.json +++ b/en-US/devops/version.json @@ -27,6 +27,11 @@ "summary": null, "deprecated": false }, + "CreateAppMembers": { + "title": null, + "summary": null, + "deprecated": false + }, "CreateBranch": { "title": null, "summary": null, @@ -87,6 +92,11 @@ "summary": null, "deprecated": false }, + "CreateProjectLabel": { + "title": null, + "summary": null, + "deprecated": false + }, "CreateProtectdBranch": { "title": null, "summary": null, @@ -187,6 +197,11 @@ "summary": null, "deprecated": false }, + "DeleteAppMember": { + "title": null, + "summary": null, + "deprecated": false + }, "DeleteBranch": { "title": null, "summary": null, @@ -237,6 +252,11 @@ "summary": null, "deprecated": false }, + "DeleteProjectLabel": { + "title": null, + "summary": null, + "deprecated": false + }, "DeleteProtectedBranch": { "title": null, "summary": null, @@ -312,6 +332,11 @@ "summary": null, "deprecated": false }, + "GetApplication": { + "title": null, + "summary": null, + "deprecated": false + }, "GetBranchInfo": { "title": null, "summary": null, @@ -497,6 +522,11 @@ "summary": null, "deprecated": false }, + "GetWorkitemFile": { + "title": null, + "summary": null, + "deprecated": false + }, "GetWorkitemRelations": { "title": null, "summary": null, @@ -517,6 +547,21 @@ "summary": null, "deprecated": false }, + "LinkMergeRequestLabel": { + "title": null, + "summary": null, + "deprecated": false + }, + "ListApplicationMembers": { + "title": null, + "summary": null, + "deprecated": false + }, + "ListApplications": { + "title": null, + "summary": null, + "deprecated": false + }, "ListCommitStatuses": { "title": null, "summary": null, @@ -552,6 +597,11 @@ "summary": null, "deprecated": false }, + "ListMergeRequestLabels": { + "title": null, + "summary": null, + "deprecated": false + }, "ListMergeRequestPatchSets": { "title": null, "summary": null, @@ -607,6 +657,11 @@ "summary": null, "deprecated": false }, + "ListProjectLabels": { + "title": null, + "summary": null, + "deprecated": false + }, "ListProjectMembers": { "title": null, "summary": null, @@ -877,6 +932,16 @@ "summary": null, "deprecated": false }, + "UpdateAppMember": { + "title": null, + "summary": null, + "deprecated": false + }, + "UpdateApplication": { + "title": null, + "summary": null, + "deprecated": false + }, "UpdateFile": { "title": null, "summary": null, @@ -937,6 +1002,11 @@ "summary": null, "deprecated": false }, + "UpdateProjectLabel": { + "title": null, + "summary": null, + "deprecated": false + }, "UpdateProjectMember": { "title": null, "summary": null, diff --git a/en-US/dm/DescDomain.json b/en-US/dm/DescDomain.json index c50929f3f..c2a61732d 100644 --- a/en-US/dm/DescDomain.json +++ b/en-US/dm/DescDomain.json @@ -10,6 +10,13 @@ "position": "Query", "type": "Integer", "required": true + }, + { + "name": "RequireRealTimeDnsRecords", + "description": "", + "position": "Query", + "type": "Boolean", + "required": false } ] } \ No newline at end of file diff --git a/en-US/dm/version.json b/en-US/dm/version.json index f444b8392..f8fc31674 100644 --- a/en-US/dm/version.json +++ b/en-US/dm/version.json @@ -54,6 +54,7 @@ }, "DeleteInvalidAddress": { "title": null, + "summary": null, "deprecated": false }, "DeleteIpfilterByEdmId": { diff --git a/en-US/dms-enterprise/AddInstance.json b/en-US/dms-enterprise/AddInstance.json new file mode 100644 index 000000000..c102877d5 --- /dev/null +++ b/en-US/dms-enterprise/AddInstance.json @@ -0,0 +1,205 @@ +{ + "name": "AddInstance", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "DataLinkName", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "DatabasePassword", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "DatabaseUser", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "DbaId", + "description": "", + "position": "Query", + "type": "Long", + "required": true + }, + { + "name": "DdlOnline", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, + { + "name": "EcsInstanceId", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EcsRegion", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnableSellCommon", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnableSellSitd", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnableSellStable", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnableSellTrust", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "EnvType", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "ExportTimeout", + "description": "", + "position": "Query", + "type": "Integer", + "required": true + }, + { + "name": "Host", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "InstanceAlias", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "InstanceSource", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "InstanceType", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "NetworkType", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "Port", + "description": "", + "position": "Query", + "type": "Integer", + "required": true + }, + { + "name": "QueryTimeout", + "description": "", + "position": "Query", + "type": "Integer", + "required": true + }, + { + "name": "SafeRule", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Sid", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "SkipTest", + "description": "", + "position": "Query", + "type": "Boolean", + "required": false + }, + { + "name": "TemplateId", + "description": "", + "position": "Query", + "type": "Long", + "required": false + }, + { + "name": "TemplateType", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Tid", + "description": "", + "position": "Query", + "type": "Long", + "required": false + }, + { + "name": "UseDsql", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, + { + "name": "VpcId", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/dms-enterprise/DeleteStandardGroup.json b/en-US/dms-enterprise/DeleteStandardGroup.json new file mode 100644 index 000000000..7bfb0ead1 --- /dev/null +++ b/en-US/dms-enterprise/DeleteStandardGroup.json @@ -0,0 +1,23 @@ +{ + "name": "DeleteStandardGroup", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "GroupId", + "description": "", + "position": "Query", + "type": "Long", + "required": true + }, + { + "name": "Tid", + "description": "", + "position": "Query", + "type": "Long", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/dms-enterprise/GetDBTopology.json b/en-US/dms-enterprise/GetDBTopology.json index 09ad04b7e..2501e651b 100644 --- a/en-US/dms-enterprise/GetDBTopology.json +++ b/en-US/dms-enterprise/GetDBTopology.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "LogicDbId", - "description": "The ID of the logical database.\n\n> You can call the [ListLogicDatabases](~~141874~~) operation to query the ID of the logical database.", + "description": "The ID of the logical database. You can call the [ListLogicDatabases](https://www.alibabacloud.com/help/en/data-management-service/latest/listlogicdatabases) or [SearchDatabase](https://www.alibabacloud.com/help/en/data-management-service/latest/searchdatabase) operation to query the ID of the logical database.", "position": "Query", "type": "Long", "required": true diff --git a/en-US/dms-enterprise/GetStandardGroup.json b/en-US/dms-enterprise/GetStandardGroup.json new file mode 100644 index 000000000..e4674fc0d --- /dev/null +++ b/en-US/dms-enterprise/GetStandardGroup.json @@ -0,0 +1,23 @@ +{ + "name": "GetStandardGroup", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "GroupId", + "description": "", + "position": "Query", + "type": "Long", + "required": true + }, + { + "name": "Tid", + "description": "", + "position": "Query", + "type": "Long", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/dms-enterprise/ModifyInstance.json b/en-US/dms-enterprise/ModifyInstance.json new file mode 100644 index 000000000..8a8ac238f --- /dev/null +++ b/en-US/dms-enterprise/ModifyInstance.json @@ -0,0 +1,212 @@ +{ + "name": "ModifyInstance", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "DataLinkName", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "DatabasePassword", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "DatabaseUser", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "DbaId", + "description": "", + "position": "Query", + "type": "Long", + "required": true + }, + { + "name": "DdlOnline", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, + { + "name": "EcsInstanceId", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EcsRegion", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnableSellCommon", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnableSellSitd", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnableSellStable", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnableSellTrust", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "EnvType", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "ExportTimeout", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, + { + "name": "Host", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "InstanceAlias", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "InstanceId", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "InstanceSource", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "InstanceType", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "NetworkType", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Port", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, + { + "name": "QueryTimeout", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, + { + "name": "SafeRule", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Sid", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "SkipTest", + "description": "", + "position": "Query", + "type": "Boolean", + "required": false + }, + { + "name": "TemplateId", + "description": "", + "position": "Query", + "type": "Long", + "required": false + }, + { + "name": "TemplateType", + "description": "", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Tid", + "description": "", + "position": "Query", + "type": "Long", + "required": false + }, + { + "name": "UseDsql", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, + { + "name": "VpcId", + "description": "", + "position": "Query", + "type": "String", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/dms-enterprise/PauseDataCorrectSQLJob.json b/en-US/dms-enterprise/PauseDataCorrectSQLJob.json index 5e29604a2..2a3e2b250 100644 --- a/en-US/dms-enterprise/PauseDataCorrectSQLJob.json +++ b/en-US/dms-enterprise/PauseDataCorrectSQLJob.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "JobId", - "description": "The ID of the SQL task. You can call the [GetDataCorrectTaskDetail](~~208481~~) and [ListDBTaskSQLJob](~~207049~~) operations to obtain the value of this parameter.\n\n> If the Type parameter is set to SINGLE, you must pass the value of the JobId parameter to confirm the ID of the SQL task that you want to rerun.", + "description": "The ID of the SQL task. You can call the [GetDataCorrectTaskDetail](~~208481~~) or [ListDBTaskSQLJob](~~207049~~) operation to obtain the value of this parameter.\n\n> If Type is set to SINGLE, you must pass in the value of JobId to confirm the ID of the SQL task that you want to pause.", "position": "Query", "type": "Long", "required": false @@ -21,7 +21,7 @@ }, { "name": "Tid", - "description": "The ID of the tenant. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.", + "description": "The tenant ID. You can call the [GetUserActiveTenant](~~198073~~) operation to query the tenant ID.", "position": "Query", "type": "Long", "required": false diff --git a/en-US/dms-enterprise/UpdateStandardGroup.json b/en-US/dms-enterprise/UpdateStandardGroup.json new file mode 100644 index 000000000..6135851b3 --- /dev/null +++ b/en-US/dms-enterprise/UpdateStandardGroup.json @@ -0,0 +1,37 @@ +{ + "name": "UpdateStandardGroup", + "deprecated": false, + "protocol": "HTTP|HTTPS", + "method": "GET|POST", + "pathPattern": "", + "parameters": [ + { + "name": "Description", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "GroupId", + "description": "", + "position": "Query", + "type": "Long", + "required": true + }, + { + "name": "GroupName", + "description": "", + "position": "Query", + "type": "String", + "required": true + }, + { + "name": "Tid", + "description": "", + "position": "Query", + "type": "Long", + "required": false + } + ] +} \ No newline at end of file diff --git a/en-US/dms-enterprise/version.json b/en-US/dms-enterprise/version.json index 28ec3112c..94f9c7d00 100644 --- a/en-US/dms-enterprise/version.json +++ b/en-US/dms-enterprise/version.json @@ -7,6 +7,10 @@ "summary": "Adds a masking rule.", "deprecated": false }, + "AddInstance": { + "title": "AddInstance", + "deprecated": false + }, "AddLhMembers": { "title": "AddLhMembers", "summary": "Adds a workspace administrator, a workspace member, or a task flow developer in Data Management (DMS).", @@ -34,7 +38,7 @@ }, "BackFill": { "title": "BackFill", - "summary": "Backfills data for task orchestration.", + "summary": "Backfills data for a task flow.", "deprecated": false }, "BuyPayAsYouGoOrder": { @@ -144,7 +148,7 @@ }, "CreateSQLReviewOrder": { "title": "CreateSQLReviewOrder", - "summary": "Creates an SQL review ticket.", + "summary": "Creates a SQL review ticket.", "deprecated": false }, "CreateScenario": { @@ -227,6 +231,11 @@ "summary": "Deletes a business scenario.", "deprecated": false }, + "DeleteStandardGroup": { + "title": null, + "summary": null, + "deprecated": false + }, "DeleteTask": { "title": "DeleteTask", "summary": "Deletes a task in a specified task flow.", @@ -314,7 +323,7 @@ }, "GetDBTopology": { "title": "GetDBTopology", - "summary": "Queries the topologies of a logical database and its physical databases shards.", + "summary": "Queries the topologies of a logical database and its physical database shards.", "deprecated": false }, "GetDataArchiveCount": { @@ -507,6 +516,11 @@ "summary": "Queries the details of optimization suggestions. The operation applies only to the tickets for the data changes and SQL review.", "deprecated": false }, + "GetStandardGroup": { + "title": null, + "summary": null, + "deprecated": false + }, "GetStructSyncExecSqlDetail": { "title": "GetStructSyncExecSqlDetail", "summary": "Queries the SQL statements that are involved in a schema synchronization ticket.", @@ -857,6 +871,10 @@ "summary": "Modifies the masking rule bound to a specified field.", "deprecated": false }, + "ModifyInstance": { + "title": "ModifyInstance", + "deprecated": false + }, "MoveTaskFlowToScenario": { "title": "MoveTaskFlowToScenario", "summary": "Migrates a task flow to a specified business scenario.", @@ -869,7 +887,7 @@ }, "PauseDataCorrectSQLJob": { "title": "PauseDataCorrectSQLJob", - "summary": "Pauses an SQL task for data change.", + "summary": "Pauses a SQL task for data change.", "deprecated": false }, "PreviewWorkflow": { @@ -1012,6 +1030,11 @@ "summary": "Updates the name and description of the business scenario for a specified task flow.", "deprecated": false }, + "UpdateStandardGroup": { + "title": null, + "summary": null, + "deprecated": false + }, "UpdateTaskConfig": { "title": "UpdateTaskConfig", "summary": "Updates the advanced configuration of a task node.", diff --git a/en-US/dts/ConfigureDtsJob.json b/en-US/dts/ConfigureDtsJob.json index 125e86294..18f84601f 100644 --- a/en-US/dts/ConfigureDtsJob.json +++ b/en-US/dts/ConfigureDtsJob.json @@ -229,6 +229,20 @@ "type": "String", "required": true }, + { + "name": "MaxDu", + "description": "", + "position": "Query", + "type": "Double", + "required": false + }, + { + "name": "MinDu", + "description": "", + "position": "Query", + "type": "Double", + "required": false + }, { "name": "RegionId", "description": "The URL of the Object Storage Service (OSS) bucket that stores the files related to the DTS task.", diff --git a/en-US/dts/ConfigureSubscription.json b/en-US/dts/ConfigureSubscription.json index b63f17a06..86eede53b 100644 --- a/en-US/dts/ConfigureSubscription.json +++ b/en-US/dts/ConfigureSubscription.json @@ -89,6 +89,20 @@ "type": "String", "required": false }, + { + "name": "MaxDu", + "description": "", + "position": "Query", + "type": "Double", + "required": false + }, + { + "name": "MinDu", + "description": "", + "position": "Query", + "type": "Double", + "required": false + }, { "name": "RegionId", "description": "The ID of the region in which the Data Transmission Service (DTS) instance resides. For more information, see [List of supported regions](~~141033~~).", diff --git a/en-US/dts/CreateDtsInstance.json b/en-US/dts/CreateDtsInstance.json index 5b301d4fa..6f9f8c03e 100644 --- a/en-US/dts/CreateDtsInstance.json +++ b/en-US/dts/CreateDtsInstance.json @@ -75,6 +75,20 @@ "type": "String", "required": false }, + { + "name": "MaxDu", + "description": "", + "position": "Query", + "type": "Double", + "required": false + }, + { + "name": "MinDu", + "description": "", + "position": "Query", + "type": "Double", + "required": false + }, { "name": "PayType", "description": "The billing method. Valid values:\n\n* **PrePaid**: subscription\n* **PostPaid**: pay-as-you-go\n\n> This parameter must be specified.", diff --git a/en-US/dts/version.json b/en-US/dts/version.json index cdc126c96..8038496cd 100644 --- a/en-US/dts/version.json +++ b/en-US/dts/version.json @@ -167,8 +167,8 @@ "deprecated": false }, "DescribeDataCheckReportUrl": { - "title": null, - "summary": null, + "title": "DescribeDataCheckReportUrl", + "summary": "Queries the download URL of the data consistency verification report.", "deprecated": false }, "DescribeDataCheckTableDetails": { diff --git a/en-US/eci/CreateContainerGroup.json b/en-US/eci/CreateContainerGroup.json index 18e8e964c..79d51513b 100644 --- a/en-US/eci/CreateContainerGroup.json +++ b/en-US/eci/CreateContainerGroup.json @@ -78,6 +78,13 @@ "type": "String", "required": false }, + { + "name": "ComputeCategory", + "description": "指定算力类别。", + "position": "Query", + "type": "RepeatList", + "required": false + }, { "name": "Container", "description": "The information about the containers.", @@ -471,7 +478,7 @@ }, { "name": "CpuArchitecture", - "description": "", + "description": "指定ECI实例的CPU架构。取值范围：\n\n- AMD64（默认值）\n- ARM64", "position": "Query", "type": "String", "required": false @@ -889,14 +896,14 @@ }, { "name": "OsType", - "description": "", + "description": "指定ECI实例的操作系统。取值范围：\n\n- Linux（默认值）\n- Windows\n\n> Windows实例正在邀测中，如需使用，请提交工单申请。", "position": "Query", "type": "String", "required": false }, { "name": "OverheadReservationOption", - "description": "", + "description": "系统开销预留选项。", "position": "Query", "type": "Struct", "required": false diff --git a/en-US/eci/DescribeContainerGroupPrice.json b/en-US/eci/DescribeContainerGroupPrice.json index 194320ce2..c00458cf9 100644 --- a/en-US/eci/DescribeContainerGroupPrice.json +++ b/en-US/eci/DescribeContainerGroupPrice.json @@ -5,6 +5,13 @@ "method": "GET|POST", "pathPattern": "", "parameters": [ + { + "name": "ComputeCategory", + "description": "算力类别。取值为economy时，表示查询经济型规格的价格。", + "position": "Query", + "type": "String", + "required": false + }, { "name": "Cpu", "description": "The number of vCPUs. For information about the vCPU and memory specifications that are supported by Elastic Container Instance, see [vCPU and memory specifications](~~114662~~).", diff --git a/en-US/eci/DescribeContainerGroups.json b/en-US/eci/DescribeContainerGroups.json index 89b7f8717..e8893526b 100644 --- a/en-US/eci/DescribeContainerGroups.json +++ b/en-US/eci/DescribeContainerGroups.json @@ -5,6 +5,13 @@ "method": "GET|POST", "pathPattern": "", "parameters": [ + { + "name": "ComputeCategory", + "description": "算力类别。取值为economy时，表示查询经济型规格的实例。", + "position": "Query", + "type": "String", + "required": false + }, { "name": "ContainerGroupIds", "description": "The IDs of the elastic container instances in JSON format. You can specify up to 20 IDs.", diff --git a/en-US/eci/UpdateContainerGroup.json b/en-US/eci/UpdateContainerGroup.json index 28ca9b112..646f79de3 100644 --- a/en-US/eci/UpdateContainerGroup.json +++ b/en-US/eci/UpdateContainerGroup.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "AcrRegistryInfo", - "description": "The information about the Container Registry Enterprise Edition instance.", + "description": "Details of the Container Registry Enterprise Edition instance that hosts the image of the init container.", "position": "Query", "type": "RepeatList", "required": false, @@ -387,14 +387,14 @@ }, { "name": "Cpu", - "description": "The number of vCPUs allocated to the elastic container instance.", + "description": "The number of vCPUs that are allocated to the elastic container instance.", "position": "Query", "type": "Float", "required": false }, { "name": "DnsConfig.NameServer", - "description": "The IP addresses of the DNS servers.", + "description": "The IP addresses of DNS servers.", "position": "Query", "type": "RepeatList", "required": false @@ -456,7 +456,7 @@ }, { "name": "InitContainer", - "description": "The information about the new init containers.", + "description": "The information about the new init container.", "position": "Query", "type": "RepeatList", "required": false, @@ -573,7 +573,7 @@ }, { "name": "Memory", - "description": "The memory size allocated to the elastic container instance. Unit: GiB.", + "description": "The size of the memory that is allocated to the elastic container instance. Unit: GiB.", "position": "Query", "type": "Float", "required": false @@ -622,7 +622,7 @@ }, { "name": "UpdateType", - "description": "The update type. Valid values:\n\n* RenewUpdate: full update. You must specify all relevant parameters to update the instance. For a parameter of the List type, you must specify all the items contained in the parameter even if you want to update only some of the items. For a parameter of the struct type, you must specify all the members if you want to update only some of the members.\n* IncrementalUpdate: incremental update. You can specify only the parameter that needs to be updated. Other related parameters remain unchanged.\n\nDefault value: RenewUpdate.", + "description": "The update type. Valid values:\n\n* RenewUpdate: full updates. You must specify all relevant parameters to update the elastic container instance. For a parameter of the list type, you must specify all the items contained in the parameter even if you want to update only some of the items. For a parameter of the struct type, you must specify all the members even if you want to update only some of the members.\n* IncrementalUpdate: incremental updates. You may specify only the parameter that you want to update. Other related parameters remain unchanged.\n\nDefault value: RenewUpdate.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/CreateActivation.json b/en-US/ecs/CreateActivation.json index c96971d13..b4e7d18d9 100644 --- a/en-US/ecs/CreateActivation.json +++ b/en-US/ecs/CreateActivation.json @@ -6,42 +6,42 @@ "parameters": [ { "name": "Description", - "description": "The description of the activation code. The description can be 1 to 100 characters in length and cannot start with `http://` or `https://`.", + "description": "The description of the activation code. It must be 1 to 100 characters in length.", "position": "Query", "type": "String", "required": false }, { "name": "InstanceCount", - "description": "The maximum number of times that the activation code can be used to register managed instances. Valid values: 1 to 1000.\n\nDefault value: 10.", + "description": "The maximum number of times that you can use the activation code to register managed instances. Valid values: 1 to 1000.\n\nDefault value: 10.", "position": "Query", "type": "Integer", "required": false }, { "name": "InstanceName", - "description": "The default instance name prefix. The instance name prefix must be 1 to 50 characters in length. It must start with a letter and cannot start with `http://` or `https://`. The instance name prefix can contain only letters, digits, periods (.), underscores (\\_), hyphens (-), and colons (:).\n\nIf you use the activation code created by calling the CreateActivation operation to register managed instances, the instances are assigned sequential names that are prefixed by the value of this parameter. You can also specify a new instance name to override the assigned sequential name when you register a managed instance.\n\nIf you specify InstanceName when you register a managed instance, an instance name in the format of `-` is generated. The number of digits in the \\ value is determined by that in the `InstanceCount` value. Example: `001`. If you do not specify InstanceName, the hostname (Hostname) is used as the instance name.", + "description": "The default instance name prefix. The instance name prefix must be 2 to 50 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, periods (.), underscores (\\_), hyphens (-), and colons (:).\n\nIf you use the activation code that is created by calling this operation (CreateActivation) to register managed instances, the instances are assigned sequential names that are prefixed by the value of this parameter. You can also specify a new instance name to replace the assigned sequential name when you register a managed instance.\n\nIf you specify InstanceName when you register a managed instance, an instance name in the format of `-` is generated. The number of digits in the \\ value is determined by that in the `InstanceCount` value. Example: `001`. If you do not specify InstanceName, the hostname (Hostname) is used as the instance name.", "position": "Query", "type": "String", "required": false }, { "name": "IpAddressRange", - "description": "The IP addresses of hosts that are allowed to use the activation code. The value can be IPv4 addresses, IPv6 addresses, or CIDR blocks.", + "description": "The IP addresses of hosts that can use the activation code. The value can be IPv4 addresses, IPv6 addresses, or CIDR blocks.", "position": "Query", "type": "String", "required": false }, { "name": "RegionId", - "description": "The ID of the region in which to create the activation code. Supported regions: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Hangzhou), China (Shanghai), China (Shenzhen), China (Heyuan), and China (Hong Kong).\n\nYou can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.", + "description": "The ID of the region in which to create the activation code. Supported regions: China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Ulanqab), China (Hangzhou), China (Shanghai), China (Shenzhen), China (Heyuan), China (Guangzhou), China (Chengdu), China (Hong Kong), Singapore, Japan (Tokyo), US (Silicon Valley), and US (Virginia).\n\nYou can all the [DescribeRegions](~~25609~~) operation to query the most recent region list.", "position": "Query", "type": "String", "required": true }, { "name": "ResourceGroupId", - "description": "", + "description": "The ID of the resource group to which to assign the activation code.", "position": "Query", "type": "String", "required": false @@ -69,7 +69,7 @@ }, { "name": "TimeToLiveInHours", - "description": "The validity period of the activation code. The activation code cannot be used to register new instances after the validity period expires. Unit: hours. Valid values: 1 to 24.\n\nDefault value: 4.", + "description": "The validity period of the activation code. The activation code can no longer be used to register instances after the period expires. Unit: hours. Valid values: 1 to 876576, which represents a range of time from 1 hour to 100 years.\n\nDefault value: 4.", "position": "Query", "type": "Long", "required": false diff --git a/en-US/ecs/CreateAutoProvisioningGroup.json b/en-US/ecs/CreateAutoProvisioningGroup.json index e545f1383..6301ec8e7 100644 --- a/en-US/ecs/CreateAutoProvisioningGroup.json +++ b/en-US/ecs/CreateAutoProvisioningGroup.json @@ -6,21 +6,21 @@ "parameters": [ { "name": "AutoProvisioningGroupName", - "description": "The name of the auto provisioning group. The name must be 2 to 128 characters in length, and can contain letters, digits, colons (:), underscores (\\_), and hyphens (-). It must start with a letter but cannot start with `http://` or `https://`.", + "description": "The name of the auto provisioning group. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).", "position": "Query", "type": "String", "required": false }, { "name": "AutoProvisioningGroupType", - "description": "The delivery type of the auto provisioning group. Valid values:\n\n* request: one-time asynchronous delivery. The auto provisioning group attempts to asynchronously deliver an instance cluster that meets the target capacity only once when it is started. The group does not retry the operation regardless of whether all the instances are delivered.\n* instant: one-time synchronous delivery. The auto provisioning group attempts to synchronously deliver an instance cluster that meets the target capacity only once when it is started. The list of delivered instances and the causes of delivery failures are returned in the response.\n* maintain: continuous delivery. The auto provisioning group attempts to deliver an instance cluster that meets the target capacity, and monitors the real-time capacity when it is started. If the target capacity of the auto provisioning group is not reached, the auto provisioning group continues to create instances until the target capacity is reached.\n\nDefault value: maintain.", + "description": "The delivery type of the auto provisioning group. Valid values:\n\n* request: one-time asynchronous delivery. When the auto provisioning group is started, it attempts to asynchronously deliver an instance cluster that meets the target capacity only once. The group does not retry the operation regardless of whether all the instances are delivered.\n* instant: one-time synchronous delivery. When the auto provisioning group is started, it attempts to synchronously deliver an instance cluster that meets the target capacity only once. The list of delivered instances and the causes of delivery failures are returned in the response.\n* maintain: continuous delivery. When the auto provisioning group is started, it attempts to deliver an instance cluster that meets the target capacity, and monitors the real-time capacity. If the target capacity of the auto provisioning group is not reached, the auto provisioning group continues to create instances until the target capacity is reached.\n\nDefault value: maintain.", "position": "Query", "type": "String", "required": false }, { "name": "ClientToken", - "description": "The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).", + "description": "The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).", "position": "Query", "type": "String", "required": false @@ -42,7 +42,7 @@ }, { "name": "DefaultTargetCapacityType", - "description": "The type of supplemental instances. If the sum of the values of the `PayAsYouGoTargetCapacity` and `SpotTargetCapacity` parameters is smaller than the value of the `TotalTargetCapacity` parameter, the auto provisioning group creates instances of the specified type to meet the capacity requirements. Valid values:\n\n* PayAsYouGo: pay-as-you-go instances\n* Spot: preemptible instances.\n\nDefault value: Spot.", + "description": "The type of supplemental instances. When the sum of the `PayAsYouGoTargetCapacity` and `SpotTargetCapacity` values is smaller than the `TotalTargetCapacity` value, the auto provisioning group creates instances of the specified type to meet the total target capacity. Valid values:\n\n* PayAsYouGo: pay-as-you-go instances\n* Spot: preemptible instances.\n\nDefault value: Spot.", "position": "Query", "type": "String", "required": false @@ -63,7 +63,7 @@ }, { "name": "HibernationOptionsConfigured", - "description": "> This parameter is in invitational preview and is unavailable for general users.", + "description": ">This parameter is in invitational preview and is not publicly available.", "position": "Query", "type": "Boolean", "required": false @@ -97,14 +97,14 @@ }, { "name": "LaunchConfiguration.AutoReleaseTime", - "description": "按量付费实例的自动释放时间。按照[ISO8601](~~25696~~)标准表示，使用UTC+0时间。格式为：`yyyy-MM-ddTHH:mm:ssZ`。\n\n- 如果秒（`ss`）取值不是`00`，则自动取为当前分钟（`mm`）开始时。\n\n- 最短释放时间为当前时间半小时之后。\n\n- 最长释放时间不能超过当前时间三年。", + "description": "The automatic release time of the instance. Specify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\n* If the value of `ss` is not `00`, the time is automatically rounded to the nearest minute based on the value of `mm`.\n* The specified time must be at least 30 minutes later than the current time.\n* The specified time can be at most three years from the current time.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.CreditSpecification", - "description": "The performance mode of the burstable instance. Valid values:\n\n* Standard: the standard mode. For more information, see the \"Standard mode\" section in the [Burstable instances](~~59977~~) topic.\n* Unlimited: the unlimited mode. For more information, see the \"Unlimited mode\" section in [Burstable instances](~~59977~~).\n\nThis parameter is empty by default.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The performance mode of the burstable instance. Valid values:\n\n* Standard: the standard mode. For more information, see the \"Standard mode\" section in [Overview of burstable instances](~~59977~~).\n* Unlimited: the unlimited mode. For more information, see the \"Unlimited mode\" section in [Overview of burstable instances](~~59977~~).\n\nThis parameter is empty by default.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false @@ -180,126 +180,126 @@ }, { "name": "LaunchConfiguration.DeploymentSetId", - "description": "The ID of the deployment set to which to deploy the instance.", + "description": "The ID of the deployment set.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.HostName", - "description": "The hostname of the instance. Take note of the following items:\n\n* The hostname cannot start or end with a period (.) or hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-).\n* For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. It can contain letters, digits, and hyphens (-).\n* For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).\n* You cannot specify both the `LaunchConfiguration.HostName` and `LaunchConfiguration.HostNames.N` parameters. Otherwise, an error is returned.\n* If both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The instance hostname. Take note of the following items:\n\n* The hostname cannot start or end with a period (.) or hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-).\n* For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. It can contain letters, digits, and hyphens (-).\n* For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).\n* You cannot specify both `LaunchConfiguration.HostName` and `LaunchConfiguration.HostNames.N`. Otherwise, an error is returned.\n* When both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.HostNames", - "description": "The hostname of the instance. You can use this parameter to specify different hostnames for multiple instances. Take note of the following items:\n\n* This parameter takes effect only when `AutoProvisioningGroupType` is set to instant.\n* The value of N indicates the number of instances. Valid values: 1 to 1000. The value of N must be the same as the TotalTargetCapacity value.\n* The hostname cannot start or end with a period (.) or hyphen (-). It cannot contain consecutive periods (.) or hyphens (-).\n* For a Windows instance, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. The hostname can contain letters, digits, and hyphens (-).\n* For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-).\n* You cannot specify both the `LaunchConfiguration.HostName` and `LaunchConfiguration.HostNames.N` parameters. Otherwise, an error is returned.\n* If both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The hostname of instance N. You can use this parameter to specify different hostnames for multiple instances. Take note of the following items:\n\n- This parameter takes effect only when `AutoProvisioningGroupType` is set to instant. \n- The value of N indicates the number of instances. Valid values of N: 1 to 1000. The value of N must be the same as the TotalTargetCapacity value. \n- The hostname cannot start or end with a period (.) or hyphen (-). The hostname cannot contain consecutive periods (.) or hyphens (-). \n- For Windows instances, the hostname must be 2 to 15 characters in length and cannot contain periods (.) or contain only digits. The hostname can contain letters, digits, and hyphens (-). \n- For instances that run other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate the hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-). \n- You cannot specify both `LaunchConfiguration.HostName` and `LaunchConfiguration.HostNames.N`. Otherwise, an error is returned. \n- When both LaunchTemplateId and LaunchConfiguration.* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "RepeatList", "required": false }, { "name": "LaunchConfiguration.ImageFamily", - "description": "", + "description": "The name of the image family. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `aliyun` or `acs:`. The name cannot contain `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (_), and hyphens (-).", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.ImageId", - "description": "The ID of the image that you want to use to create the instance. You can call the [DescribeImages](~~25534~~) operation to query available image resources. If both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The ID of the image to be used to create the instance. You can call the [DescribeImages](~~25534~~) operation to query available image resources. When both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.InstanceDescription", - "description": "The description of the instance. The description must be 2 to 256 characters in length. The description can contain letters but cannot start with `http://` or `https://`. If both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The instance description. The description must be 2 to 256 characters in length. The description can contain letters and cannot start with `http://` or `https://`. When both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.InstanceName", - "description": "The name of the instance . The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-). The default value of this parameter is the `InstanceId` value.\n\nWhen you batch create instances, you can batch configure sequential names for the instances. For more information, see [Batch configure sequential names or hostnames for multiple instances](~~196048~~).\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The instance name. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. The name can contain letters, digits, colons (:), underscores (\\_), periods (.), and hyphens (-). The default value of this parameter is the `InstanceId` value.\n\nWhen you batch create instances, you can batch configure sequential names for the instances. For more information, see [Batch configure sequential names or hostnames for multiple instances](~~196048~~).\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.InternetChargeType", - "description": "The billing method for network usage. Valid values:\n\n* PayByBandwidth: pay-by-bandwidth\n* PayByTraffic: pay-by-traffic\n\n> If the pay-by-traffic billing method for network usage is used, the maximum inbound and outbound bandwidths are used as the upper limits of bandwidths instead of guaranteed performance specifications. In scenarios where demand outstrips resource supplies, these maximum bandwidth values may not be reached. If you want guaranteed bandwidths for your instances, use the pay-by-bandwidth billing method for network usage.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The billing method for network usage. Valid values:\n\n* PayByBandwidth: pay-by-bandwidth\n* PayByTraffic: pay-by-traffic\n\n> When the pay-by-traffic billing method for network usage is used, the maximum inbound and outbound bandwidth values are used as the upper limits of bandwidth instead of guaranteed performance specifications. When demands outstrip resource supplies, the maximum bandwidths may be limited. If you want guaranteed bandwidth for your instance, use the pay-by-bandwidth billing method.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.InternetMaxBandwidthIn", - "description": "The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:\n\n* When the purchased outbound public bandwidth is less than or equal to 10 Mbit/s, the valid values of this parameter are 1 to 10 and the default value is 10.\n* When the purchased outbound public bandwidth is greater than 10 Mbit/s, the valid values of this parameter are 1 to the value of `LaunchConfiguration.InternetMaxBandwidthOut`, and the default value is the value of `LaunchConfiguration.InternetMaxBandwidthOut`.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The maximum inbound public bandwidth. Unit: Mbit/s. Valid values:\n\n* When the maximum outbound public bandwidth is less than or equal to 10 Mbit/s, the valid values of this parameter are 1 to 10 and the default value is 10.\n* When the maximum outbound public bandwidth is greater than 10 Mbit/s, the valid values of this parameter are 1 to the value of `LaunchConfiguration.InternetMaxBandwidthOut`, and the default value is the value of `LaunchConfiguration.InternetMaxBandwidthOut`.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "Integer", "required": false }, { "name": "LaunchConfiguration.InternetMaxBandwidthOut", - "description": "The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100.\n\nDefault value: 0.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The maximum outbound public bandwidth. Unit: Mbit/s. Valid values: 0 to 100.\n\nDefault value: 0.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "Integer", "required": false }, { "name": "LaunchConfiguration.IoOptimized", - "description": "Specifies whether to create an I/O optimized instance. Valid values:\n\n* none: The instance is not I/O optimized.\n* optimized: The instance is I/O optimized.\n\nFor instances of retired instance types, the default value is none. For instances of other instance types, the default value is optimized.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "Specifies whether the instance is I/O optimized. Valid values:\n\n* none: The instance is not I/O optimized.\n* optimized: The instance is I/O optimized.\n\nFor instances of retired instance types, the default value is none. For instances of other instance types, the default value is optimized.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.KeyPairName", - "description": "The name of the key pair to bind to the instance.\n\n* For Windows instances, this parameter is ignored. This parameter is empty by default.\n* By default, password-based logon is disabled for Linux instances.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The key pair name.\n\n* For Windows instances, this parameter is ignored. This parameter is empty by default.\n* By default, password-based logon is disabled for Linux instances.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.Password", - "description": "The password of the instance. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include:\n\n``()`~!@#$%^&*-_+=|{}`[]`:;'<>,.?/``\n\nFor Windows instances, the password cannot start with a forward slash (/).\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The instance password. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. The password can contain the following special characters:\n\n``( ) ` ~ ! @ # $ % ^ & * - _ + = | { } ``: ; ' < > , . ? /`` For Windows instances, the password cannot start with a forward slash (/). When both LaunchTemplateId and LaunchConfiguration.* parameters are specified, LaunchTemplateId takes precedence. `", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.PasswordInherit", - "description": "Specifies whether to use the preset password of the image. Valid values:\n\n* true: uses the preset password.\n* false: does not use the preset password.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "Specifies whether to use the password preset in the image. Valid values:\n\n* true: uses the password preset in the image.\n* false: does not use the password preset in the image.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "Boolean", "required": false }, { "name": "LaunchConfiguration.RamRoleName", - "description": "The name of the instance Resource Access Management (RAM) role. You can call the [ListRoles](~~28713~~) operation provided by RAM to query the instance RAM roles that you created. If both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The name of the instance Resource Access Management (RAM) role. You can call the [ListRoles](~~28713~~) operation provided by RAM to query the instance RAM roles that you created. When both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.ResourceGroupId", - "description": "The ID of the resource group to which to assign the instance. If both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The ID of the resource group to which to assign the instance. When both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.SecurityEnhancementStrategy", - "description": "Indicates whether security hardening is enabled. Valid values:\n\n* Active: Security hardening is enabled. This value is applicable only to public images.\n* Deactive: Security hardening is disabled. This value is applicable to all image types.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "Specifies whether to enable security hardening. Valid values:\n\n* Active: enables security hardening. This value is applicable only to public images.\n* Deactive: disables security hardening. This value is applicable to all image types.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.SecurityGroupId", - "description": "The ID of security group N to which to assign the instance. If both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The ID of the security group to which to assign the instance. When both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false @@ -313,49 +313,49 @@ }, { "name": "LaunchConfiguration.SystemDisk", - "description": "The information of the system disk on the instance. If both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The information of the system disk on the instance. If both the LaunchTemplateId and LaunchConfiguration.* parameters are specified, the LaunchTemplateId parameter takes precedence.", "position": "Query", "type": "Struct", "required": false }, { "name": "LaunchConfiguration.SystemDiskCategory", - "description": "The category of the system disk. Valid values:\n\n* cloud_efficiency: ultra disk.\n* cloud_ssd: standard SSD.\n* cloud_essd: enhanced SSD (ESSD)\n* cloud: basic disk.\n\nFor non-I/O optimized instances of retired instance types, the default value is cloud. For other instances, the default value is cloud_efficiency.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The category of the system disk. Valid values:\n\n* cloud_efficiency: ultra disk\n* cloud_ssd: standard SSD\n* cloud_essd: enhanced SSD (ESSD)\n* cloud: basic disk\n\nFor non-I/O optimized instances of retired instance types, the default value is cloud. For other instances, the default value is cloud_efficiency.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.SystemDiskDescription", - "description": "The description of the system disk. The description must be 2 to 256 characters in length. The description can contain letters but cannot start with `http://` or `https://`.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The description of the system disk. The description must be 2 to 256 characters in length. The description can contain letters and cannot start with `http://` or `https://`.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.SystemDiskName", - "description": "The name of the system disk. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), colons (:), underscores (\\_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.\n\nThis parameter is empty by default.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The name of the system disk. The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, periods (.), colons (:), underscores (\\_), and hyphens (-).\n\nThis parameter is empty by default.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.SystemDiskPerformanceLevel", - "description": "The performance level of the ESSD that you want to use as the system disk. Default value: PL0. Valid values:\n\n* PL0: A single ESSD can deliver up to 10,000 random read/write IOPS.\n* PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.\n* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.\n* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.\n\nFor more information about ESSD performance levels, see [ESSDs](~~122389~~).\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The performance level of the ESSD to be used as the system disk. Valid values:\n\n* PL0 (default): A single ESSD can deliver up to 10,000 random read/write IOPS.\n* PL1: A single ESSD can deliver up to 50,000 random read/write IOPS.\n* PL2: A single ESSD can deliver up to 100,000 random read/write IOPS.\n* PL3: A single ESSD can deliver up to 1,000,000 random read/write IOPS.\n\nFor more information about ESSD performance levels, see [ESSDs](~~122389~~).\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false }, { "name": "LaunchConfiguration.SystemDiskSize", - "description": "The size of the system disk. Valid values: 20 to 500. Unit: GiB. This parameter value must be at least 20 and greater than or equal to the size of the image specified by the LaunchConfiguration.ImageId parameter.\n\nDefault value: 40 or the size of the image specified by the LaunchConfiguration.ImageId parameter, whichever is greater.\n\nIf both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The size of the system disk. Valid values: 20 to 500. Unit: GiB. The value must be at least 20 and greater than or equal to the size of the image specified by LaunchConfiguration.ImageId.\n\nDefault value: 40 or the size of the image specified by LaunchConfiguration.ImageId, whichever is greater.\n\nWhen both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "Integer", "required": false }, { "name": "LaunchConfiguration.Tag", - "description": "The tags in the extended configurations of the launch template.", + "description": "The tag in the extended configurations of the launch template.", "position": "Query", "type": "RepeatList", "required": false, @@ -376,7 +376,7 @@ }, { "name": "LaunchConfiguration.UserData", - "description": "The user data of the instance. The user data must be encoded in Base64. The raw data can be up to 16 KB in size. If both the LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The instance user data. The user data must be encoded in Base64. The raw data can be up to 16 KB in size. When both LaunchTemplateId and LaunchConfiguration.\\* parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false @@ -464,7 +464,7 @@ }, { "name": "LaunchTemplateId", - "description": "The ID of the launch template associated with the auto provisioning group. You can call the [DescribeLaunchTemplates](~~73759~~) operation to query available launch templates. If both the LaunchTemplateId and `LaunchConfiguration.*` parameters are specified, the LaunchTemplateId parameter takes precedence.", + "description": "The ID of the launch template associated with the auto provisioning group. You can call the [DescribeLaunchTemplates](~~73759~~) operation to query available launch templates. When both LaunchTemplateId and `LaunchConfiguration.*` parameters are specified, LaunchTemplateId takes precedence.", "position": "Query", "type": "String", "required": false @@ -478,21 +478,21 @@ }, { "name": "MaxSpotPrice", - "description": "The maximum price of preemptible instances in the auto provisioning group.\n\n> If the `MaxSpotPrice` and `LaunchTemplateConfig.N.MaxPrice` parameters are both specified, the lower price is used.", + "description": "The maximum price of preemptible instances in the auto provisioning group.\n\n> When both `MaxSpotPrice` and `LaunchTemplateConfig.N.MaxPrice` are specified, the smaller one of the two parameter values is used.", "position": "Query", "type": "Float", "required": false }, { "name": "MinTargetCapacity", - "description": "The minimum target capacity of the auto provisioning group. The value must be a positive integer.\n\nWhen you specify this parameter, take note of the following items:\n\n* This parameter takes effect only when `AutoProvisioningGroupType` is set to instant.\n* If the number of instances that can be created in the current region is smaller than the value of this parameter, the operation cannot be called and no instances are created.\n* If the number of instances that can be created in the current region is greater than the value of this parameter, instances can be created based on the specified parameters.", + "description": "The minimum target capacity of the auto provisioning group. The value must be a positive integer. When you specify this parameter, take note of the following items:\n\n- This parameter takes effect only when `AutoProvisioningGroupType` is set to instant. \n- If the number of instances that can be created in the current region is smaller than the value of this parameter, the operation cannot be called and no instances are created. \n- If the number of instances that can be created in the current region is greater than the value of this parameter, instances can be created based on the specified parameters.", "position": "Query", "type": "String", "required": false }, { "name": "PayAsYouGoAllocationStrategy", - "description": "The policy for creating pay-as-you-go instances. Valid values:\n\n* lowest-price: cost optimization policy. The auto provisioning group attempts to create instances of the lowest-priced instance type.\n* prioritized: priority-based policy. The auto provisioning group attempts to create instances based on the priority specified by the `LaunchTemplateConfig.N.Priority` parameter.\n\nDefault value: lowest-price.", + "description": "The policy for creating pay-as-you-go instances. Valid values:\n\n* lowest-price: cost optimization policy. The auto provisioning group selects the lowest-priced instance type to create instances.\n* prioritized: priority-based policy. The auto provisioning group creates instances based on the priority specified by `LaunchTemplateConfig.N.Priority`.\n\nDefault value: lowest-price.", "position": "Query", "type": "String", "required": false @@ -520,7 +520,7 @@ }, { "name": "SpotAllocationStrategy", - "description": "The policy for creating preemptible instances. Valid values:\n\n* lowest-price: cost optimization policy. The auto provisioning group attempts to create instances of the lowest-priced instance type.\n* diversified: balanced distribution policy. The auto provisioning group attempts to create instances in zones that are specified in extended configurations and then evenly distribute the instances across the zones.\n* capacity-optimized: capacity-optimized distribution policy. The auto provisioning group attempts to create instances that are of the optimal instance types across the optimal zones based on resource availability.\n\nDefault value: lowest-price.", + "description": "The policy for creating preemptible instances. Valid values:\n\n* lowest-price: cost optimization policy. The auto provisioning group selects the lowest-priced instance type to create instances.\n* diversified: balanced distribution policy. The auto provisioning group creates instances in zones that are specified in extended configurations and then evenly distributes the instances across the zones.\n* capacity-optimized: capacity-optimized distribution policy. The auto provisioning group creates instances of the optimal instance types across the optimal zones based on resource availability.\n\nDefault value: lowest-price.", "position": "Query", "type": "String", "required": false @@ -534,7 +534,7 @@ }, { "name": "SpotInstancePoolsToUseCount", - "description": "The number of preemptible instances of the lowest-priced instance type to be created by the auto provisioning group. This parameter takes effect when the `SpotAllocationStrategy` parameter is set to `lowest-price`.\n\nThe value of SpotInstancePoolsToUseCount must be smaller than the N value specified in `LaunchTemplateConfig.N.*` parameters.", + "description": "The number of preemptible instances of the lowest-priced instance type to be created by the auto provisioning group. This parameter takes effect when `SpotAllocationStrategy` is set to `lowest-price`.\n\nThe value must be smaller than the N value specified in `LaunchTemplateConfig.N`.", "position": "Query", "type": "Integer", "required": false @@ -563,35 +563,35 @@ }, { "name": "TerminateInstances", - "description": "Specifies whether to release instances in the auto provisioning group after the auto provisioning group is deleted. Valid values:\n\n* true: releases instances in the auto provisioning group.\n* false: retains instances in the auto provisioning group.\n\nDefault value: false.", + "description": "Specifies whether to release instances in the auto provisioning group when the auto provisioning group is deleted. Valid values:\n\n* true: releases the instances.\n* false: retains the instances.\n\nDefault value: false.", "position": "Query", "type": "Boolean", "required": false }, { "name": "TerminateInstancesWithExpiration", - "description": "Specifies whether to release instances in the auto provisioning group after the auto provisioning group expires. Valid values:\n\n* true: releases instances in the auto provisioning group.\n* false: only removes instances from the auto provisioning group but does not release them.\n\nDefault value: false.", + "description": "Specifies whether to release instances in the auto provisioning group when the group expires. Valid values:\n\n* true: releases the instances.\n* false: only removes the instances from the auto provisioning group but does not release them.\n\nDefault value: false.", "position": "Query", "type": "Boolean", "required": false }, { "name": "TotalTargetCapacity", - "description": "The total target capacity of the auto provisioning group. The value must be a positive integer.\n\nThe total target capacity of the auto provisioning group must be greater than or equal to the sum of the target capacity of pay-as-you-go instances specified by the `PayAsYouGoTargetCapacity` parameter and the target capacity of preemptible instances specified by the `SpotTargetCapacity` parameter.", + "description": "The total target capacity of the auto provisioning group. The value must be a positive integer.\n\nThe total target capacity of the auto provisioning group must be greater than or equal to the sum of the target capacity of pay-as-you-go instances specified by `PayAsYouGoTargetCapacity` and the target capacity of preemptible instances specified by `SpotTargetCapacity`.", "position": "Query", "type": "String", "required": true }, { "name": "ValidFrom", - "description": "The time at which to start the auto provisioning group. The period of time between this point in time and the point in time specified by the `ValidUntil` parameter is the effective time period of the auto provisioning group.\n\nSpecify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\nBy default, an auto provisioning group is started immediately after it is created.", + "description": "The time at which to start the auto provisioning group. The period of time between this point in time and the point in time specified by `ValidUntil` is the validity period of the auto provisioning group.\n\nSpecify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\nBy default, an auto provisioning group is started immediately after it is created.", "position": "Query", "type": "String", "required": false }, { "name": "ValidUntil", - "description": "The expiration time of the auto provisioning group. The period of time between this point in time and the point in time specified by the `ValidFrom` parameter is the effective time period of the auto provisioning group.\n\nSpecify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\nDefault value: 2099-12-31T23:59:59Z.", + "description": "The time at which the auto provisioning group expires. The period of time between this point in time and the point in time specified by `ValidFrom` is the validity period of the auto provisioning group.\n\nSpecify the time in the [ISO 8601](~~25696~~) standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.\n\nDefault value: 2099-12-31T23:59:59Z.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/CreateDisk.json b/en-US/ecs/CreateDisk.json index 83d9d7a78..1c75fc930 100644 --- a/en-US/ecs/CreateDisk.json +++ b/en-US/ecs/CreateDisk.json @@ -152,7 +152,7 @@ }, { "name": "StorageClusterId", - "description": "The ID of the dedicated block storage cluster. To create a disk in a specific dedicated block storage cluster, specify this parameter. For more information about dedicated block storage clusters, see [What is Dedicated Block Storage Cluster?](~~208883~~)\n\n> You cannot specify storage set-related parameters (`StorageSetId` and `StorageSetPartitionNumber`) and the dedicated block storage cluster-related parameter (`StorageClusterId`) at the same time. Otherwise, the operation cannot be called.", + "description": "The ID of the dedicated block storage cluster. To create a disk in a specific dedicated block storage cluster, specify this parameter.\n\n> You cannot specify storage set-related parameters (`StorageSetId` and `StorageSetPartitionNumber`) and the dedicated block storage cluster-related parameter (`StorageClusterId`) at the same time. Otherwise, the operation cannot be called.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/CreateLaunchTemplate.json b/en-US/ecs/CreateLaunchTemplate.json index c45179b54..aa76077fb 100644 --- a/en-US/ecs/CreateLaunchTemplate.json +++ b/en-US/ecs/CreateLaunchTemplate.json @@ -348,7 +348,7 @@ }, { "name": "SpotDuration", - "description": "The protection period of the preemptible instance. Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6.\n\n* The following protection periods are available in invitational preview: 2, 3, 4, 5, and 6 hours. If you want to set this parameter to one of these values, submit a ticket.\n* A value of 0 indicates that no protection period is configured for the preemptible instance.\n\nDefault value: 1.", + "description": "The protection period of the preemptible instance. Unit: hours. Default value: 1. Valid values:\n\n- 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After the 1-hour protection period ends, the system compares the bidding price with the market price and checks the resource inventory to determine whether to retain or release the instance. \n\n- 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system compares the biding price with the market price and checks the resource inventory to determine whether to retain or release the instance. \n\nAlibaba Cloud sends ECS system events to notify you 5 minutes before the instance is released. Preemptible instances are billed by second. We recommend that you specify a protection period based on your business requirements. \n\n>If you set SpotStrategy to SpotWithPriceLimit or SpotAsPriceGo, this parameter takes effect.", "position": "Query", "type": "Integer", "required": false diff --git a/en-US/ecs/CreateLaunchTemplateVersion.json b/en-US/ecs/CreateLaunchTemplateVersion.json index c46d8f786..fcb689aab 100644 --- a/en-US/ecs/CreateLaunchTemplateVersion.json +++ b/en-US/ecs/CreateLaunchTemplateVersion.json @@ -390,7 +390,7 @@ }, { "name": "SystemDisk.Category", - "description": "The category of the system disk. Valid values:\n\n* cloud: basic disk\n* cloud_efficiency: ultra disk\n* cloud_ssd: standard SSD.\n* cloud_essd: enhanced SSD (ESSD). You can use the `SystemDisk.PerformanceLevel` parameter to set the performance level of the ESSD to use as the system disk.\n\nFor non-I/O optimized instances of a retired instance type, the default value is cloud. For other types of instances, the default value is cloud_efficiency.", + "description": "The category of the system disk. Valid values:\n\n* cloud: basic disk\n* cloud_efficiency: ultra disk\n* cloud_ssd: standard SSD\n* cloud_auto: ESSD AutoPL disk\n* cloud_essd: enhanced SSD (ESSD). You can use the `SystemDisk.PerformanceLevel` parameter to set the performance level of the ESSD to use as the system disk.\n\nFor non-I/O optimized instances of a retired instance type, the default value is cloud. For other types of instances, the default value is cloud_efficiency.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/CreateNetworkInterface.json b/en-US/ecs/CreateNetworkInterface.json index cc9134ac9..740d031c7 100644 --- a/en-US/ecs/CreateNetworkInterface.json +++ b/en-US/ecs/CreateNetworkInterface.json @@ -138,9 +138,16 @@ "type": "String", "required": false }, + { + "name": "RxQueueSize", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, { "name": "SecondaryPrivateIpAddressCount", - "description": "The number of private IP addresses to be automatically created by ECS.", + "description": "The number of private IP addresses to be automatically created by ECS.\nValid values: 1 to 49.", "position": "Query", "type": "Integer", "required": false @@ -180,6 +187,13 @@ } ] }, + { + "name": "TxQueueSize", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, { "name": "VSwitchId", "description": "The ID of the vSwitch with which to associate the ENI. Private IP addresses are assigned to the ENI from within the CIDR block of the vSwitch.", diff --git a/en-US/ecs/DeleteAutoProvisioningGroup.json b/en-US/ecs/DeleteAutoProvisioningGroup.json index 0621ca943..2a59eaaa8 100644 --- a/en-US/ecs/DeleteAutoProvisioningGroup.json +++ b/en-US/ecs/DeleteAutoProvisioningGroup.json @@ -23,7 +23,7 @@ "description": "Specifies whether to release instances in the auto provisioning group. Valid values:\n\n* true: releases instances in the auto provisioning group.\n* false: retains instances in the auto provisioning group.", "position": "Query", "type": "Boolean", - "required": true + "required": false } ] } \ No newline at end of file diff --git a/en-US/ecs/DescribeActivations.json b/en-US/ecs/DescribeActivations.json index d30151e95..9fa4fcb3a 100644 --- a/en-US/ecs/DescribeActivations.json +++ b/en-US/ecs/DescribeActivations.json @@ -20,14 +20,14 @@ }, { "name": "MaxResults", - "description": "", + "description": "The maximum number of entries per page.\n\nValid values: 1 to 50.\n\nDefault value: 10.", "position": "Query", "type": "Integer", "required": false }, { "name": "NextToken", - "description": "", + "description": "The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.", "position": "Query", "type": "String", "required": false @@ -55,7 +55,7 @@ }, { "name": "ResourceGroupId", - "description": "", + "description": "The ID of the resource group to which the activation code belongs.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/DescribeAutoProvisioningGroups.json b/en-US/ecs/DescribeAutoProvisioningGroups.json index 6f73f7662..a68555c23 100644 --- a/en-US/ecs/DescribeAutoProvisioningGroups.json +++ b/en-US/ecs/DescribeAutoProvisioningGroups.json @@ -45,6 +45,13 @@ "position": "Query", "type": "String", "required": true + }, + { + "name": "ResourceGroupId", + "description": "", + "position": "Query", + "type": "String", + "required": false } ] } \ No newline at end of file diff --git a/en-US/ecs/DescribeAvailableResource.json b/en-US/ecs/DescribeAvailableResource.json index 58ecc8fc7..92eab12ed 100644 --- a/en-US/ecs/DescribeAvailableResource.json +++ b/en-US/ecs/DescribeAvailableResource.json @@ -91,7 +91,7 @@ }, { "name": "SpotDuration", - "description": "The protection period of the preemptible instance. Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6.\n\n* The following protection periods are available in invitational preview: 2, 3, 4, 5, and 6 hours. If you want to set this parameter to one of these values, submit a ticket.\n* If this parameter is set to 0, no protection period is configured for the preemptible instance.\n\nDefault value: 1.", + "description": "The protection period of the preemptible instance. Unit: hours. Default value: 1. Valid values:\n\n- 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After the 1-hour protection period ends, the system compares the bidding price with the market price and checks the resource inventory to determine whether to retain or release the instance.\n\n- 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system compares the biding price with the market price and checks the resource inventory to determine whether to retain or release the instance.\n\nAlibaba Cloud sends ECS system events to notify you 5 minutes before the instance is released. Preemptible instances are billed by the second. We recommend that you specify a protection period based on your business requirements.\n\n>If you set SpotStrategy to SpotWithPriceLimit or SpotAsPriceGo, this parameter takes effect.", "position": "Query", "type": "Integer", "required": false diff --git a/en-US/ecs/DescribeBandwidthLimitation.json b/en-US/ecs/DescribeBandwidthLimitation.json index 3b94923c3..0e0fbfe32 100644 --- a/en-US/ecs/DescribeBandwidthLimitation.json +++ b/en-US/ecs/DescribeBandwidthLimitation.json @@ -7,42 +7,42 @@ "parameters": [ { "name": "InstanceChargeType", - "description": "The preemption policy for the preemptible or pay-as-you-go instance. Valid values:\n\n* NoSpot: The instance is a regular pay-as-you-go instance.\n* SpotWithPriceLimit: The instance is a preemptible instance with user-defined maximum hourly prices.\n* SpotAsPriceGo: The system automatically offers a bid, which is not higher than the pay-as-you-go price for the same instance type.\n\nDefault value: NoSpot.\n\n> This parameter takes effect only when the InstanceChargeType parameter is set to PostPaid.", + "description": "The billing method of the instance. For more information, see [Billing overview](~~25398~~). Valid values:\n\n* PrePaid: subscription\n* PostPaid: pay-as-you-go\n\nDefault value: PostPaid.", "position": "Query", "type": "String", "required": false }, { "name": "InstanceType", - "description": "Specifies the operation for which to query the maximum public bandwidth. Valid values:\n\n* Upgrade: upgrades the public bandwidth.\n* Downgrade: downgrades the public bandwidth.\n* Create: creates an ECS instance.\n\nDefault value: Create.", + "description": "The instance type. For information about the values, see [Instance families](~~25378~~).", "position": "Query", "type": "String", "required": true }, { "name": "OperationType", - "description": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E", + "description": "Specifies the operation for which to query the maximum public bandwidth. Valid values:\n\n* Upgrade: upgrades the public bandwidth.\n* Downgrade: downgrades the public bandwidth.\n* Create: creates an ECS instance.\n\nDefault value: Create.", "position": "Query", "type": "String", "required": false }, { "name": "RegionId", - "description": "PrePaid", + "description": "The ID of the region. You can call the [DescribeRegions](~~DescribeRegions~~) operation to query the most recent region list.", "position": "Query", "type": "String", "required": true }, { "name": "ResourceId", - "description": "The ID of the request.", + "description": "The ID of the resource.\n\n> This parameter is required when the OperationType parameter is set to Upgrade or Downgrade.", "position": "Query", "type": "String", "required": false }, { "name": "SpotStrategy", - "description": "The ID of the resource.\n\n> This parameter is required when the OperationType parameter is set to Upgrade or Downgrade.", + "description": "The bidding policy for the pay-as-you-go instance. Valid values:\n\n* NoSpot: The instance is a regular pay-as-you-go instance.\n* SpotWithPriceLimit: The instance is a preemptible instance with user-defined maximum hourly prices.\n* SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bid price. The market price can be up to the pay-as-you-go price.\n\nDefault value: NoSpot.\n\n> The SpotStrategy parameter takes effect only when the InstanceChargeType parameter is set to PostPaid.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/DescribeInstanceTypes.json b/en-US/ecs/DescribeInstanceTypes.json index 26daff7a9..2277841b2 100644 --- a/en-US/ecs/DescribeInstanceTypes.json +++ b/en-US/ecs/DescribeInstanceTypes.json @@ -7,14 +7,14 @@ "parameters": [ { "name": "CpuArchitecture", - "description": "The CPU architecture. Valid values:\n\n* X86\n* ARM", + "description": "The CPU architecture. Valid values:\n\n* X86: x86\n* ARM: ARM", "position": "Query", "type": "String", "required": false }, { "name": "GPUSpec", - "description": "The GPU model.\n\n> Fuzzy match is supported. For example, if an instance type provides NVIDIA V100 GPUs and you set this parameter to NVIDIA, information about the instance type is queried.", + "description": "The GPU model.\n\n> Fuzzy match is supported. For example, if an instance type provides NVIDIA V100 GPUs and you set this parameter to NVIDIA, information about the instance type is queried.", "position": "Query", "type": "String", "required": false @@ -42,7 +42,7 @@ }, { "name": "InstanceTypes", - "description": "Instance type N. Valid values of N: 1 to 10. If this parameter is empty, information about all instance types is queried.", + "description": "Instance type N. Valid values of N: 1 to 10. If this parameter is left empty, information about all instance types is queried.", "position": "Query", "type": "RepeatList", "required": false @@ -63,203 +63,203 @@ }, { "name": "MaximumCpuCoreCount", - "description": "The maximum number of vCPUs. The value must be a positive integer.\n\n> If an instance type has more vCPUs than the specified value, information about the instance type is not queried.", + "description": "The maximum number of vCPUs. The value must be a positive integer.\n\n> If an instance type has more vCPUs than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MaximumCpuSpeedFrequency", - "description": "The maximum clock speed.\n\n> If an instance type uses processors that have a higher clock speed than the specified value, information about the instance type is not queried.", + "description": "The maximum clock speed.\n\n> If an instance type uses processors that have a higher clock speed than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Float", "required": false }, { "name": "MaximumCpuTurboFrequency", - "description": "The maximum turbo frequency.\n\n> If an instance type uses processors that deliver a higher turbo frequency than the specified value, information about the instance type is not queried.", + "description": "The maximum turbo frequency.\n\n> If an instance type uses processors that deliver a higher turbo frequency than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Float", "required": false }, { "name": "MaximumGPUAmount", - "description": "The maximum number of GPUs. The value must be a positive integer.\n\n> If an instance type provides more GPUs than the specified value, information about the instance type is not queried.", + "description": "The maximum number of GPUs. The value must be a positive integer.\n\n> If an instance type provides more GPUs than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MaximumMemorySize", - "description": "The maximum memory size. Unit: GiB.\n\n> If the memory size of an instance type is larger than the specified value, information about the instance type is not queried.", + "description": "The maximum memory size. Unit: GiB.\n\n> If the memory size of an instance type is larger than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Float", "required": false }, { "name": "MinimumBaselineCredit", - "description": "The minimum baseline CPU performance (overall baseline performance of all vCPUs) per t5 or t6 burstable instance.\n\n> If a t5 or t6 instance type provides baseline CPU performance that is lower than the specified value, information about the instance type is not queried.", + "description": "The minimum baseline CPU performance (overall baseline performance of all vCPUs) of a t5 or t6 burstable instance.\n\n> If a t5 or t6 instance type provides baseline CPU performance lower than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumCpuCoreCount", - "description": "The minimum number of vCPUs. The value must be a positive integer.\n\n> If an instance type has fewer vCPUs than the specified value, information about the instance type is not queried.", + "description": "The minimum number of vCPUs. The value must be a positive integer.\n\n> If an instance type has fewer vCPUs than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumCpuSpeedFrequency", - "description": "The minimum clock speed.\n\n> If an instance type uses processors that have a lower clock speed than the specified value, information about the instance type is not queried.", + "description": "The minimum clock speed.\n\n> If an instance type uses processors that have a lower clock speed than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Float", "required": false }, { "name": "MinimumCpuTurboFrequency", - "description": "The minimum turbo frequency.\n\n> If an instance type uses processors that deliver a lower turbo frequency than the specified value, information about the instance type is not queried.", + "description": "The minimum turbo frequency.\n\n> If an instance type uses processors that deliver a lower turbo frequency than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Float", "required": false }, { "name": "MinimumDiskQuantity", - "description": "The minimum number of cloud disks.\n\n> If an instance type supports fewer cloud disks than the specified value, information about the instance type is not queried.", + "description": "The minimum number of cloud disks per instance.\n\n> If an instance type supports fewer cloud disks than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumEniIpv6AddressQuantity", - "description": "The minimum number of IPv6 addresses per ENI.\n\n> If an instance type supports fewer IPv6 addresses per ENI than the specified value, information about the instance type is not queried.", + "description": "The minimum number of IPv6 addresses per ENI.\n\n> If an instance type supports fewer IPv6 addresses per ENI than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumEniPrivateIpAddressQuantity", - "description": "The minimum number of IPv4 addresses per ENI.\n\n> If an instance type supports fewer IPv4 addresses per ENI than the specified value, information about the instance type is not queried.", + "description": "The minimum number of IPv4 addresses per ENI.\n\n> If an instance type supports fewer IPv4 addresses per ENI than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumEniQuantity", - "description": "The minimum number of elastic network interfaces (ENIs).\n\n> If an instance type supports fewer ENIs than the specified value, information about the instance type is not queried.", + "description": "The minimum number of elastic network interfaces (ENIs) per instance.\n\n> If an instance type supports fewer ENIs than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumEriQuantity", - "description": "The minimum number of ERIs.\n\n> If an instance type supports fewer ERIs than the specified value, information about the instance type is not queried.", + "description": "The minimum number of ERIs per instance.\n\n> If an instance type supports fewer ERIs than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumGPUAmount", - "description": "The minimum number of GPUs. The value must be a positive integer.\n\n> If an instance type provides fewer GPUs than the specified value, information about the instance type is not queried.", + "description": "The minimum number of GPUs. The value must be a positive integer.\n\n> If an instance type provides fewer GPUs than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumInitialCredit", - "description": "The minimum initial CPU credits per t5 or t6 burstable instance.\n\n> If a t5 or t6 instance type provides less initial vCPU credits than the specified value, information about the instance type is not queried.", + "description": "The minimum initial CPU credits of a t5 or t6 burstable instance.\n\n> If a t5 or t6 instance type provides less initial vCPU credits than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumInstanceBandwidthRx", - "description": "The minimum inbound internal bandwidth. Unit: Kbit/s.\n\n> If an instance type provides an inbound internal bandwidth that is lower than the specified value, information about the instance type is not queried.", + "description": "The minimum inbound internal bandwidth. Unit: Kbit/s.\n\n> If an instance type provides an inbound internal bandwidth that is lower than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumInstanceBandwidthTx", - "description": "The minimum outbound internal bandwidth. Unit: Kbit/s.\n\n> If an instance type provides an outbound internal bandwidth that is lower than the specified value, information about the instance type is not queried.", + "description": "The minimum outbound internal bandwidth. Unit: Kbit/s.\n\n> If an instance type provides an outbound internal bandwidth that is lower than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumInstancePpsRx", - "description": "The minimum inbound packet forwarding rate over the internal network. Unit: pps.\n\n> If an instance type provides an inbound packet forwarding rate over the internal network that is lower than the specified value, information about the instance type is not queried.", + "description": "The minimum inbound packet forwarding rate over the internal network. Unit: pps.\n\n> If an instance type provides an inbound packet forwarding rate over the internal network that is lower than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Long", "required": false }, { "name": "MinimumInstancePpsTx", - "description": "The minimum outbound packet forwarding rate over the internal network. Unit: pps.\n\n> If an instance type provides an outbound packet forwarding rate over the internal network that is lower than the specified value, information about the instance type is not queried.", + "description": "The minimum outbound packet forwarding rate over the internal network. Unit: pps.\n\n> If an instance type provides an outbound packet forwarding rate over the internal network that is lower than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Long", "required": false }, { "name": "MinimumLocalStorageAmount", - "description": "The minimum number of local disks.\n\n> If an instance type supports fewer local disks than the specified value, information about the instance type is not queried.", + "description": "The minimum number of local disks per instance.\n\n> If an instance type supports fewer local disks than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumLocalStorageCapacity", - "description": "The capacity of each local disk. Unit: GiB.", + "description": "The capacity of each local disk attached per instance. Unit: GiB.", "position": "Query", "type": "Long", "required": false }, { "name": "MinimumMemorySize", - "description": "The minimum memory size. Unit: GiB.\n\n> If the memory size of an instance type is smaller than the specified value, information about the instance type is not queried.", + "description": "The minimum memory size. Unit: GiB.\n\n> If the memory size of an instance type is smaller than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Float", "required": false }, { "name": "MinimumPrimaryEniQueueNumber", - "description": "The minimum default number of queues per primary network interface controller (NIC).\n\n> If an instance type supports fewer queues per primary NIC than the specified value, information about the instance type is not queried.", + "description": "The minimum default number of queues per primary network interface controller (NIC).\n\n> If an instance type supports fewer queues per primary NIC than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumQueuePairNumber", - "description": "The minimum number of queue pair (QP) queues per elastic RDMA interface (ERI).\n\n> If an instance type supports fewer QP queues per ERI than the specified value, information about the instance type is not queried.", + "description": "The minimum number of queue pair (QP) queues per elastic RDMA interface (ERI).\n\n> If an instance type supports fewer QP queues per ERI than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "MinimumSecondaryEniQueueNumber", - "description": "The minimum default number of queues per secondary NIC.\n\n> If an instance type supports fewer queues per secondary NIC than the specified value, information about the instance type is not queried.", + "description": "The minimum default number of queues per secondary NIC.\n\n> If an instance type supports fewer queues per secondary NIC than the specified value, information about the instance type is not queried.", "position": "Query", "type": "Integer", "required": false }, { "name": "NextToken", - "description": "The query token. Set the value to the NextToken value returned in the previous call to the DescribeInstanceTypes operation. Leave this parameter empty the first time you call this operation.", + "description": "The query token. Set the value to the NextToken value returned in the previous call to the DescribeInstanceTypes operation. You do not need to specify this parameter for the first request.", "position": "Query", "type": "String", "required": false }, { "name": "NvmeSupport", - "description": "Specifies whether cloud disks can be attached by using the NVMe protocol. Valid values:\n\n* required: Cloud disks can be attached by using the NVMe protocol.\n* unsupported: Cloud disk cannot be attached by using the NVMe protocol.", + "description": "Specifies whether cloud disks can be attached by using the NVMe protocol. Valid values:\n\n* required: The cloud disk can be attached by using the NVMe protocol.\n* unsupported: The cloud disk cannot be attached by using the NVMe protocol.", "position": "Query", "type": "String", "required": false }, { "name": "PhysicalProcessorModel", - "description": "The CPU model.\n\n> Fuzzy match is supported. For example, if an instance type uses Intel Xeon (Ice Lake) Platinum 8369B processors and you set this parameter to Intel, information about the instance type is queried.", + "description": "The CPU model.\n\n> Fuzzy match is supported. For example, if an instance type uses Intel Xeon (Ice Lake) Platinum 8369B processors and you set this parameter to Intel, information about the instance type is queried.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/DescribeKeyPairs.json b/en-US/ecs/DescribeKeyPairs.json index 38cf6c3e6..89c6aff8a 100644 --- a/en-US/ecs/DescribeKeyPairs.json +++ b/en-US/ecs/DescribeKeyPairs.json @@ -7,21 +7,21 @@ "parameters": [ { "name": "KeyPairFingerPrint", - "description": "Details about the key pairs.", + "description": "The fingerprint of the key pair. The message-digest algorithm 5 (MD5) is used based on the public key fingerprint format defined in RFC 4716. For more information, see [RFC 4716](https://tools.ietf.org/html/rfc4716).", "position": "Query", "type": "String", "required": false }, { "name": "KeyPairName", - "description": "The value of tag N of the key pair. Valid values of N: 1 to 20.", + "description": "The name of the key pair. You can use the asterisk (\\*) symbol as a wildcard in regular expressions to perform a fuzzy search for key pairs. Sample patterns:\n\n* `*SshKey`: queries key pairs whose names end with SshKey, including the key pair named SshKey.\n* `SshKey*`: queries key pairs whose names start with SshKey, including the key pair named SshKey.\n* `*SshKey*`: queries key pairs whose names include SshKey, including the key pair named SshKey.\n* `SshKey`: queries the key pair named SshKey.", "position": "Query", "type": "String", "required": false }, { "name": "PageNumber", - "description": "The operation that you want to perform. Set the value to **DescribeKeyPairs**.", + "description": "The number of the page to return. Pages start from page 1.\n\nDefault value: 1.", "position": "Query", "type": "Integer", "required": false @@ -35,21 +35,21 @@ }, { "name": "RegionId", - "description": "The fingerprint of the key pair. The message-digest algorithm 5 (MD5) is used based on the public key fingerprint format defined in RFC 4716. For more information, see [RFC 4716](https://tools.ietf.org/html/rfc4716).", + "description": "The region ID of the key pair. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.", "position": "Query", "type": "String", "required": true }, { "name": "ResourceGroupId", - "description": "The tag key of the key pair.", + "description": "The ID of the resource group. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.\n\n> Resources in the default resource group are displayed in the response regardless of how this parameter is set.", "position": "Query", "type": "String", "required": false }, { "name": "Tag", - "description": "The fingerprint of the key pair.", + "description": "The tags.", "position": "Query", "type": "RepeatList", "required": false, diff --git a/en-US/ecs/DescribeManagedInstances.json b/en-US/ecs/DescribeManagedInstances.json index ce1c17098..908de8b50 100644 --- a/en-US/ecs/DescribeManagedInstances.json +++ b/en-US/ecs/DescribeManagedInstances.json @@ -34,14 +34,14 @@ }, { "name": "MaxResults", - "description": "", + "description": "The maximum number of entries per page.\n\nValid values: 1 to 50.\n\nDefault value: 10.", "position": "Query", "type": "Integer", "required": false }, { "name": "NextToken", - "description": "", + "description": "The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.", "position": "Query", "type": "String", "required": false @@ -76,7 +76,7 @@ }, { "name": "ResourceGroupId", - "description": "", + "description": "The ID of the resource group to which the managed instance belongs.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/DescribeNetworkInterfaceAttribute.json b/en-US/ecs/DescribeNetworkInterfaceAttribute.json index e67e37d8a..b6d5082c1 100644 --- a/en-US/ecs/DescribeNetworkInterfaceAttribute.json +++ b/en-US/ecs/DescribeNetworkInterfaceAttribute.json @@ -7,7 +7,7 @@ "parameters": [ { "name": "Attribute", - "description": "The attributes of the ENI.", + "description": "The attribute of the ENI. Valid values:\n\nattachment: attachment information about the ENI \n\n>This parameter is in invitational preview and is not publicly available.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/DescribeNetworkInterfaces.json b/en-US/ecs/DescribeNetworkInterfaces.json index 1e36562c7..b12351797 100644 --- a/en-US/ecs/DescribeNetworkInterfaces.json +++ b/en-US/ecs/DescribeNetworkInterfaces.json @@ -49,14 +49,14 @@ }, { "name": "PageNumber", - "description": "The number of the page to return.\n\nPages start from page 1.\n\nDefault value: 1.\n\n> This parameter will be removed in the future. We recommend that you use the NextToken and MaxResults parameters to perform a paged query.", + "description": ">This parameter is no longer used. We recommend that you specify the MaxResults or NextToken parameter for a paged query.", "position": "Query", "type": "Integer", "required": false }, { "name": "PageSize", - "description": "The number of entries to return on each page.\n\nMaximum value: 1000.\n\nDefault value: 10.\n\n> This parameter will be removed in the future. We recommend that you use the NextToken and MaxResults parameters for a paged query.", + "description": ">This parameter is no longer used. We recommend that you specify the MaxResults or NextToken parameter for a paged query.", "position": "Query", "type": "Integer", "required": false diff --git a/en-US/ecs/DescribePrice.json b/en-US/ecs/DescribePrice.json index b74483b33..457e6764f 100644 --- a/en-US/ecs/DescribePrice.json +++ b/en-US/ecs/DescribePrice.json @@ -271,7 +271,7 @@ }, { "name": "SpotDuration", - "description": "The retention period of the preemptible instance. Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6\n\n* The following protection periods are unavailable: 2, 3, 4, 5, and 6 hours. If you want to set this parameter to one of these values, [submit a ticket](https://workorder-intl.console.aliyun.com/#/ticket/createIndex) and enter the following information: - The specifications and number of the resources. Example: ecs.g6.8xlarge 1000. - The region where the resources reside. Example: China (Beijing). - The period of time during which the resources are used every day. Example: 1:00 to 4: 00 every day.\n* A value of 0 indicates that no protection period is specified for the preemptible instance.\n\nDefault value: 1.", + "description": "The protection period of the preemptible instance. Unit: hours. Default value: 1. Valid values:\n\n- 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After the 1-hour protection period ends, the system compares the bidding price with the market price and checks the resource inventory to determine whether to retain or release the instance.\n\n- 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system compares the biding price with the market price and checks the resource inventory to determine whether to retain or release the instance.\n\nAlibaba Cloud sends ECS system events to notify you 5 minutes before the instance is released. Preemptible instances are billed by second. We recommend that you specify a protection period based on your business requirements.\n\n>If you set SpotStrategy to SpotWithPriceLimit or SpotAsPriceGo, this parameter takes effect.", "position": "Query", "type": "Integer", "required": false diff --git a/en-US/ecs/DescribeSpotPriceHistory.json b/en-US/ecs/DescribeSpotPriceHistory.json index ddc3c91a2..d7aa73c31 100644 --- a/en-US/ecs/DescribeSpotPriceHistory.json +++ b/en-US/ecs/DescribeSpotPriceHistory.json @@ -7,70 +7,70 @@ "parameters": [ { "name": "EndTime", - "description": "The beginning of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC. The specified time can be up to 30 days earlier than the specified EndTime value.\n\nThis parameter is empty by default. If this parameter is empty, the time that is 3 hours earlier than the specified EndTime value is used.", + "description": "The type of the operating system platform. Valid values:\n\n* linux\n* windows", "position": "Query", "type": "String", "required": false }, { "name": "InstanceType", - "description": "The network type of the preemptible instance. Valid values:\n\n* classic: classic network\n* vpc: Virtual Private Cloud (VPC)", + "description": "The beginning of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC. The specified time can be up to 30 days earlier than the specified EndTime value.\n\nThis parameter is empty by default. If this parameter is empty, the time that is 3 hours earlier than the specified EndTime value is used.", "position": "Query", "type": "String", "required": true }, { "name": "IoOptimized", - "description": "The protection period of the preemptible instance. Unit: hours. Valid values: 0, 1, 2, 3, 4, 5, and 6.\n\n* The following protection periods are available in invitational preview: 2, 3, 4, 5, and 6 hours. If you want to set this parameter to one of these values, submit a ticket.\n* If this parameter is set to 0, no protection period is configured for the preemptible instance.\n\nDefault value: 1.", + "description": "Specifies whether the instance is I/O optimized. Valid values:\n\n* optimized: The instance is I/O optimized.\n* none: The instance is not I/O optimized.\n\nFor instances of generation I instance families, the default value is none.\n\nFor instances of other instance families, the default value is optimized.", "position": "Query", "type": "String", "required": false }, { "name": "NetworkType", - "description": "The zone ID of the preemptible instance.", + "description": "The network type of the preemptible instance. Valid values:\n\n* classic: classic network\n* vpc: Virtual Private Cloud (VPC)", "position": "Query", "type": "String", "required": true }, { "name": "OSType", - "description": "The end of the time range to query. Specify the time in the [ISO 8601](~~25696~~) standard in the `yyyy-MM-ddTHH:mm:ssZ` format. The time must be in UTC.\n\nThis parameter is empty by default. If this parameter is empty, the current time is used.", + "description": "The type of the operating system platform. Valid values:\n\n- linux\n- windows", "position": "Query", "type": "String", "required": false }, { "name": "Offset", - "description": "The type of the operating system platform. Valid values:\n\n* linux\n* windows", + "description": "The line from which the query starts. \n\nDefault value: 0.", "position": "Query", "type": "Integer", "required": false }, { "name": "RegionId", - "description": "Queries the price history of a preemptible instance within the last 30 days.", + "description": "The zone ID of the preemptible instance.", "position": "Query", "type": "String", "required": true }, { "name": "SpotDuration", - "description": "The instance type of the preemptible instance.", + "description": "The protection period of the preemptible instance. Unit: hours. Default value: 1. Valid values: \n\n- 1: After a preemptible instance is created, Alibaba Cloud ensures that the instance is not automatically released within 1 hour. After the 1-hour protection period ends, the system compares the bidding price with the market price and checks the resource inventory to determine whether to retain or release the instance. \n\n- 0: After a preemptible instance is created, Alibaba Cloud does not ensure that the instance runs for 1 hour. The system compares the biding price with the market price and checks the resource inventory to determine whether to retain or release the instance. \n\nAlibaba Cloud sends Elastic Compute Service (ECS) system events to notify you 5 minutes before the instance is released. Preemptible instances are billed by the second. We recommend that you specify a protection period based on your business requirements. \n\n>If you set SpotStrategy to SpotWithPriceLimit or SpotAsPriceGo, this parameter takes effect.", "position": "Query", "type": "Integer", "required": false }, { "name": "StartTime", - "description": "Specifies whether the instance is I/O optimized. Valid values:\n\n* optimized: The instance is I/O optimized.\n* none: The instance is not I/O optimized.\n\nFor instances of generation I instance families, the default value is none.\n\nFor instances of other instance families, the default value is optimized.", + "description": "The time that corresponds to the queried spot price. The time is in the `yyyy-MM-ddTHH:mm:ssZ` format.", "position": "Query", "type": "String", "required": false }, { "name": "ZoneId", - "description": "The region ID of the preemptible instance. You can call the [DescribeRegions](~~25609~~) operation to query the most recent region list.", + "description": "The spot price (market price) of the preemptible instance.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/InvokeCommand.json b/en-US/ecs/InvokeCommand.json index edebf4aee..2a0611a34 100644 --- a/en-US/ecs/InvokeCommand.json +++ b/en-US/ecs/InvokeCommand.json @@ -44,7 +44,7 @@ "description": "The IDs of the instances on which you want to run the command. You can specify a maximum of 50 instance IDs in each request. Valid values of N: 1 to 50.", "position": "Query", "type": "RepeatList", - "required": true + "required": false }, { "name": "Parameters", @@ -74,6 +74,27 @@ "type": "String", "required": false }, + { + "name": "ResourceTag", + "description": "", + "position": "Query", + "type": "RepeatList", + "required": false, + "sub_parameters": [ + { + "name": "Key", + "position": "Query", + "type": "String", + "required": false + }, + { + "name": "Value", + "position": "Query", + "type": "String", + "required": false + } + ] + }, { "name": "Tag", "description": "The tags to add to the command.", diff --git a/en-US/ecs/ModifyInstanceAttribute.json b/en-US/ecs/ModifyInstanceAttribute.json index c06e0980d..66b3dba79 100644 --- a/en-US/ecs/ModifyInstanceAttribute.json +++ b/en-US/ecs/ModifyInstanceAttribute.json @@ -7,56 +7,56 @@ "parameters": [ { "name": "CpuOptions.TopologyType", - "description": "", + "description": "The CPU topology type of the instance. Valid values: \n\n- ContinuousCoreToHTMapping: The Hyper-Threading (HT) technology allows continuous threads to run on the same core in the CPU topology of the instance. \n\n- DiscreteCoreToHTMapping: The HT technology allows discrete threads to run on the same core in the CPU topology of the instance. \n\nThis parameter is empty by default. \n\n>- This parameter is supported only by specific instance families. For more information about the supported instance families, see [View and modify the CPU topology](~~2636059~~).\n>- Before you specify this parameter, make sure that the instance is in the Stopped state.", "position": "Query", "type": "String", "required": false }, { "name": "CreditSpecification", - "description": "The performance mode of the burstable instance. Valid values:\n\n* Standard: standard mode.\n* Unlimited: unlimited mode.\n\nFor more information about the performance modes of burstable instances, see [Burstable instances](~~59977~~).", + "description": "The performance mode of the burstable instance. Valid values:\n\n* Standard\n* Unlimited\n\nFor more information about the performance modes of burstable instances, see [Overview](~~59977~~).", "position": "Query", "type": "String", "required": false }, { "name": "DeletionProtection", - "description": "The release protection attribute of the instance. This parameter specifies whether you can use the ECS console or call the [DeleteInstance](~~25507~~) operation to release the instance.\n\n> This parameter is applicable to only pay-as-you-go instances. It can protect instances against manual releases, but not against automatic releases.", + "description": "The release protection attribute of the instance. This parameter specifies whether you can use the ECS console or call the [DeleteInstance](~~25507~~) operation to release the instance.\n\n> This parameter is applicable only to pay-as-you-go instances. The release protection attribute can protect instances against manual releases, but not against automatic releases.", "position": "Query", "type": "Boolean", "required": false }, { "name": "Description", - "description": "The description of the instance. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.\n\nThis parameter is empty by default.", + "description": "The instance description. The description must be 2 to 256 characters in length, and cannot start with `http://` or `https://`.\n\nThis parameter is empty by default.", "position": "Query", "type": "String", "required": false }, { "name": "EnableJumboFrame", - "description": "实例MTU是否开启Jumbo frame通信模式，取值范围：\n\n-true：开启。\n\n-false：不开启。\n\n目前仅部分规格支持开启Jumbo frame，更多详情，请参见[ECS实例MTU](~~200512~~)。", + "description": "Specifies whether to enable the Jumbo Frame feature for the MTU of the instance.\n\n* true\n\n* false\n\nYou can enable the Jumbo Frame feature for only specific instance types. For more information, see [MTUs](~~200512~~).", "position": "Query", "type": "Boolean", "required": false }, { "name": "HostName", - "description": "The hostname of the instance. Take note of the following items:\n\n* When you modify the hostname of an instance, the instance must not be in the Creating (Pending) or Starting (Starting) state. Otherwise, the new hostname and the configurations in `/etc/hosts` cannot take effect. You can call the [DescribeInstances](~~25506~~) operation to query the state of the instance.\n* After the hostname is modified, you must call the [RebootInstance](~~25502~~) operation to restart the instance for the new hostname to take effect.\n\nThe following limits apply to the hostnames of instances that run different operating systems:\n\n* For Windows Server, the hostname must be 2 to 15 characters in length and can contain letters, digits, and hyphens (-). It cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits.\n* For other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-). The hostname cannot contain consecutive periods (.) or hyphens (-). It cannot start or end with a period (.) or a hyphen (-).", + "description": "The hostname of the instance. Take note of the following items:\n\n* When you modify the hostname of an instance, the instance must not be in the Creating (Pending) or Starting (Starting) state. Otherwise, the new hostname and the configurations in `/etc/hosts` cannot take effect. You can call the [DescribeInstances](~~25506~~) operation to query the state of the instance.\n* After you modify the hostname, you must call the [RebootInstance](~~25502~~) operation for the new hostname to take effect.\n\nThe following limits apply to the hostnames of instances that run different operating systems:\n\n* For Windows Server, the hostname must be 2 to 15 characters in length and can contain letters, digits, and hyphens (-). It cannot start or end with a hyphen (-), contain consecutive hyphens (-), or contain only digits.\n* For other operating systems such as Linux, the hostname must be 2 to 64 characters in length. You can use periods (.) to separate a hostname into multiple segments. Each segment can contain letters, digits, and hyphens (-). The hostname cannot contain consecutive periods (.) or hyphens (-). It cannot start or end with a period (.) or a hyphen (-).", "position": "Query", "type": "String", "required": false }, { "name": "InstanceId", - "description": "The ID of the instance.", + "description": "The instance ID.", "position": "Query", "type": "String", "required": true }, { "name": "InstanceName", - "description": "The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).", + "description": "The name of the instance. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (\\_), and hyphens (-).", "position": "Query", "type": "String", "required": false @@ -70,35 +70,35 @@ }, { "name": "Password", - "description": "The password of the instance. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include:\n\n ()`~!@#$%^&*-_+=|{}[]:;'<>,.?/\n\nFor Windows instances, passwords cannot start with a forward slash (/).\n\n> If the `Password` parameter is specified, we recommend that you send requests over HTTPS to prevent password leaks.", + "description": "The password of the instance. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters. Special characters include:\n\n```\n\n()`~!@#$%^&*-_+=|{}[]:;'<>,.?/\n \n```\n\nFor Windows instances, passwords cannot start with a forward slash (/).\n\n> For security reasons, we recommend that you use HTTPS to send requests if `Password` is specified.", "position": "Query", "type": "String", "required": false }, { "name": "Recyclable", - "description": "> This parameter is in invitational preview and is not publicly available.", + "description": "> This parameter is in invitational preview and is not publicly available.", "position": "Query", "type": "Boolean", "required": false }, { "name": "RemoteConnectionOptions", - "description": "> This parameter is in invitational preview and is not publicly available.", + "description": "> This parameter is in invitational preview and is not publicly available.", "position": "Query", "type": "Struct", "required": false }, { "name": "SecurityGroupIds", - "description": "The IDs of replacement security groups.\n\n* All security group IDs must be unique.\n* The instance is moved from the current security groups to the replacement security groups. If you want the instance to remain in the current security groups, you must add the IDs of the current security groups to the list.\n* You can move the instance to security groups of a different type. However, the list cannot contain the IDs of both basic and advanced security groups.\n* The specified security groups and instance must belong to the same virtual private cloud (VPC).\n* The valid values of N are based on the maximum number of security groups to which the instance can belong. For more information, see [Limits](~~25412#SecurityGroupQuota1~~).\n* New security groups become valid for the instance after a short latency.", + "description": "The IDs of replacement security groups.\n \n* All security group IDs must be unique.\n* The instance is moved from the current security groups to the replacement security groups. If you want the instance to remain in the current security groups, you must add the IDs of the current security groups to the list.\n* You can move the instance to security groups of a different type. However, the list cannot contain the IDs of both basic and advanced security groups.\n* The specified security groups and instance must belong to the same virtual private cloud (VPC).\n* The valid values of N are based on the maximum number of security groups to which the instance can belong. For more information, see [Limits](~~25412#SecurityGroupQuota1~~).\n* New security groups become valid for the instance after a short latency.", "position": "Query", "type": "RepeatList", "required": false }, { "name": "UserData", - "description": "The user data of the instance. User data must be encoded in Base64.\n\nThe size of the user data must be no greater than 16 KB before it is encoded in Base64. We recommend that you do not pass in confidential information such as passwords and private keys in the plaintext format. If you must pass in confidential information, we recommend that you encrypt and Base64-encode the information before you pass it in. Then you can decode and decrypt the information in the same way within the instance.", + "description": "The user data of the instance. User data must be encoded in Base64.\n\nThe size of the user data cannot exceed 16 KB before it is encoded in Base64. We recommend that you do not pass in confidential information such as passwords and private keys in plaintext. If you must pass in confidential information, we recommend that you encrypt and Base64-encode the information before you pass it in. Then, you can decode and decrypt the information in the same way within the instance.", "position": "Query", "type": "String", "required": false diff --git a/en-US/ecs/ModifyNetworkInterfaceAttribute.json b/en-US/ecs/ModifyNetworkInterfaceAttribute.json index 6a1af78f6..d74d0cee7 100644 --- a/en-US/ecs/ModifyNetworkInterfaceAttribute.json +++ b/en-US/ecs/ModifyNetworkInterfaceAttribute.json @@ -47,12 +47,26 @@ "type": "String", "required": true }, + { + "name": "RxQueueSize", + "description": "", + "position": "Query", + "type": "Integer", + "required": false + }, { "name": "SecurityGroupId", "description": "The ID of security group N to which the secondary ENI finally belongs. If a security group to which the ENI has belonged is in the ID list, that security group is removed from the list. Valid values of N: 1, 2, 3, 4, and 5.\n\n> After you change the security group, the change takes effect after a short delay.", "position": "Query", "type": "RepeatList", "required": false + }, + { + "name": "TxQueueSize", + "description": "", + "position": "Query", + "type": "Integer", + "required": false } ] } \ No newline at end of file diff --git a/en-US/ecs/RunCommand.json b/en-US/ecs/RunCommand.json index c65a93043..5c0ed4251 100644 --- a/en-US/ecs/RunCommand.json +++ b/en-US/ecs/RunCommand.json @@ -6,109 +6,130 @@ "parameters": [ { "name": "ClientToken", - "description": "The client token that is used to ensure the idempotence of the request. You can use the client to generate the value that is unique among different requests. The `ClientToken` value can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).", + "description": "The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The **token** can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see [How to ensure idempotence](~~25693~~).", "position": "Query", "type": "String", "required": false }, { "name": "CommandContent", - "description": "Specifies whether to retain the command after it is run. Valid values:\n\n* true: The command is retained. You can call the InvokeCommand operation to run the command again. The retained command counts against the quota of Cloud Assistant commands.\n* false: The command is not retained. The command is automatically deleted after it is run and does not count against the quota of Cloud Assistant commands.\n\nDefault value: false", + "description": "The content of the command. The command content can be plaintext or Base64-encoded. Take note of the following items:\n\n* If you want to retain the command, make sure that the Base64-encoded command content does not exceed 18 KB in size. If you do not want to retain the command, make sure that the Base64-encoded command content does not exceed 24 KB in size. You can set `KeepCommand` to specify whether to retain the command.\n\n* If the command content is Base64-encoded, set `ContentEncoding` to Base64.\n\n* If you set `EnableParameter` to true, the custom parameter feature is enabled and you can configure custom parameters based on the following rules:\n\n * Specify custom parameters in the `{{}}` format. Within `{{}}`, the spaces and line feeds before and after the parameter names are ignored.\n * You can specify up to 20 custom parameters.\n * A custom parameter name can contain only letters, digits, underscores (\\_), and hyphens (-). The name is case-insensitive. The ACS:: prefix cannot be used to specify non-built-in environment parameters.\n * Each custom parameter name cannot exceed 64 bytes in length.\n\n* You can specify built-in environment parameters as custom parameters. Then, when you run the command, the parameters are automatically specified by Cloud Assistant. You can specify the following built-in environment parameters:\n\n * `{{ACS::RegionId}}`: the region ID.\n\n * `{{ACS::AccountId}}`: the UID of the Alibaba Cloud account.\n\n * `{{ACS::InstanceId}}`: the instance ID. When the command is run on multiple instances, if you want to specify `{{ACS::InstanceId}}` as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than the following ones:\n\n * Linux: 2.2.3.309\n * Windows: 2.1.3.309\n\n * `{{ACS::InstanceName}}`: the instance name. When the command is run on multiple instances, if you want to specify `{{ACS::InstanceName}}` as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than the following ones:\n\n * Linux: 2.2.3.344\n * Windows: 2.1.3.344\n\n * `{{ACS::InvokeId}}`: the task ID. If you want to specify `{{ACS::InvokeId}}` as a built-in environment parameter, make sure that the Cloud Assistant Agent version is not earlier than the following ones:\n\n * Linux: 2.2.3.309\n * Windows: 2.1.3.309\n\n * `{{ACS::CommandId}}`: the command ID. If you want to specify `{{ACS::CommandId}}` as a built-in environment parameter, make sure that the version of the Cloud Assistant Agent is not earlier than the following ones:\n\n * Linux: 2.2.3.309\n * Windows: 2.1.3.309", "position": "Query", "type": "String", "required": true }, { "name": "ContainerId", - "description": "The value of tag N of the command. You can specify 1 to 20 tag keys for the command. The tag value can be an empty string.\n\nIt can be up to 128 characters in length and cannot contain `http://` or `https://`.", + "description": "The ID of the container. Only 64-bit hexadecimal strings are supported. Container IDs that are prefixed with `docker://`, `containerd://`, or `cri-o://` can specify container runtimes.\n\nTake note of the following items:\n\n* If this parameter is specified, Cloud Assistant runs scripts in the specified container of the instance.\n* If this parameter is specified, scripts can run only on Linux instances on which Cloud Assistant Agent is installed. The version of Cloud Assistant Agent must be 2.2.3.344 or later.\n* If this parameter is specified, the specified `Username` and `WorkingDir` parameters do not take effect. You can run the command in the default working directory of the container by using only the default user of the container. For more information, see [Use Cloud Assistant to run commands in containers](~~456641~~).\n* If this parameter is specified, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to `#!/usr/bin/python` at the beginning of a script to specify a script interpreter. For more information, see [Use Cloud Assistant to run commands in containers](~~456641~~).", "position": "Query", "type": "String", "required": false }, { "name": "ContainerName", - "description": "Runs a shell, PowerShell, or batch command on one or more Elastic Compute Service (ECS) instances.", + "description": "The name of the container.\n\nTake note of the following items:\n\n* If this parameter is specified, Cloud Assistant runs scripts in the specified container of the instance.\n* If this parameter is specified, scripts can run only on Linux instances on which Cloud Assistant Agent is stalled. The version of Cloud Assistant Agent must be 2.2.3.344 or later.\n* If this parameter is specified, the specified `Username` and `WorkingDir` parameters do not take effect. You can run the command in the default working directory of the container by using only the default user of the container. For more information, see [Use Cloud Assistant to run commands in containers](~~456641~~).\n* If this parameter is specified, only shell scripts can be run in Linux containers. You cannot add a command in the format similar to `#!/usr/bin/python` at the beginning of a script to specify a script interpreter. For more information, see [Use Cloud Assistant to run commands in containers](~~456641~~).", "position": "Query", "type": "String", "required": false }, { "name": "ContentEncoding", - "description": "Specifies whether to run the command on a schedule. Valid values:\n\n* true: runs the command on the schedule specified by `Frequency`. The results of each execution of a command do not affect the subsequent executions of the command.\n* false: runs the command only once.\n\nDefault value: false.", + "description": "The encoding mode of command content (`CommandContent`). The valid values are case-insensitive. Valid values:\n\n* PlainText: The command content is not encoded.\n* Base64: The command content is encoded in Base64.\n\nDefault value: PlainText. If the specified value of this parameter is invalid, PlainText is used by default.", "position": "Query", "type": "String", "required": false }, { "name": "Description", - "description": "The content of the command. The command content can be plaintext or Base64-encoded. Take note of the following items:\n\n* If you want to retain the command, make sure that the Base64-encoded command content does not exceed 18 KB in size. If you do not want to retain the command, make sure that the Base64-encoded command content does not exceed 24 KB in size. You can set `KeepCommand` to specify whether to retain the command.\n\n* If the command content is Base64-encoded, set `ContentEncoding` to Base64.\n\n* When `EnableParameter` is set to true, the custom parameter feature is enabled and you can configure custom parameters based on the following rules:\n\n * Define custom parameters in the `{{}}` format. Within `{{}}`, the spaces and line feeds before and after the parameter names are ignored.\n * The number of custom parameters cannot exceed 20.\n * A custom parameter name can contain only letters, digits, underscores (\\_), and hyphens (-). The name is case-insensitive.\n * Each custom parameter name cannot exceed 64 bytes in length.\n\n* You can specify built-in environment parameters as custom parameters. Then, when you run the command, the parameters are automatically specified by Cloud Assistant. You can specify the following built-in environment parameters:\n\n * `{{ACS::RegionId}}`: the ID of the region.\n\n * `{{ACS::AccountId}}`: the UID of the Alibaba Cloud account.\n\n * `{{ACS::InstanceId}}`: the ID of the instance. If you want to run the command on multiple instances and specify `{{ACS::InstanceId}}` as a built-in environment parameter, make sure that your Cloud Assistant is of the following versions or later:\n\n * Linux: 2.2.3.309\n * Windows: 2.1.3.309\n\n * `{{ACS::InstanceName}}`: the name of the instance. If you want to run the command on multiple instances and specify `{{ACS::InstanceName}}` as a built-in environment parameter, make sure that your Cloud Assistant is of the following versions or later:\n\n * Linux: 2.2.3.344\n * Windows: 2.1.3.344\n\n * `{{ACS::InvokeId}}`: the ID of the command task. If you want to specify `{{ACS::InvokeId}}` as a built-in environment variable, make sure that your Cloud Assistant is of the following versions or later:\n\n * Linux: 2.2.3.309\n * Windows: 2.1.3.309\n\n * `{{ACS::CommandId}}`: the ID of the command. If you want to specify `{{ACS::CommandId}}` as a built-in environment parameter, make sure that your Cloud Assistant is of the following versions or later:\n\n * Linux: 2.2.3.309\n * Windows: 2.1.3.309", + "description": "The description of the command. The description supports all character sets and can be up to 512 characters in length.", "position": "Query", "type": "String", "required": false }, { "name": "EnableParameter", - "description": "The ID of the resource group to which you want to assign the command executions. When you set this parameter, take note of the following items:\n\n* The instances specified by the InstanceId.N parameter must belong to the specified resource group.\n* You can set this parameter to call the [DescribeInvocations](~~64840~~) or [DescribeInvocationResults](~~64845~~) operation to query execution results in the specified resource group.", + "description": "Specifies whether to include custom parameters in the command.\n\nDefault value: false.", "position": "Query", "type": "Boolean", "required": false }, { "name": "Frequency", - "description": "The name of the command. The name supports all character sets and can be up to 128 characters in length.", + "description": "The schedule on which to run the command. You can configure a command to run at a fixed interval based on a rate expression, run only once at a specified time, or run at designated times based on a cron expression.\n\n* To run a command at a fixed interval, use a rate expression to specify the interval. You can specify the interval in seconds, minutes, hours, or days. This option is suitable for scenarios in which tasks need to be executed at a fixed interval. Specify the interval in the following format: `rate( )`. For example, specify `rate(5m)` to run the command every 5 minutes. When you specify an interval, take note of the following limits:\n\n * The interval can be anywhere from 60 seconds to 7 days, but must be longer than the timeout period of the scheduled task.\n * The interval is the amount of time that elapses between two consecutive executions. The interval is irrelevant to the amount of time that is required to run the command once. For example, assume that you set the interval to 5 minutes and that it takes 2 minutes to run the command each time. Each time the command is run, the system waits 3 minutes before it runs the command again.\n * A task is not executed immediately after the task is created. For example, assume that you set the interval to 5 minutes for a task. The task begins to be executed 5 minutes after it is created.\n\n* To run a command only once at a specific time, specify a point in time and a time zone. Specify the point in time in the `at(yyyy-MM-dd HH:mm:ss