ModifyAliasDomainStatus
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to modify the status of an alias domain name.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ModifyAliasDomainStatus. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | The site ID. |
| Paused | Yes | Boolean | Status of the alias domain name. Values:false: Enable the alias domain name.true: Disable the alias domain name. |
| AliasNames.N | No | Array of String | The alias domain name you want to modify its status. If it is left empty, the modify operation is not performed. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Modifying the status of an alias domain name
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyAliasDomainStatus
<Common request parameters>
{
"ZoneId": "zone-28569s6od5na",
"AliasNames": [
"eo.test.com"
],
"Paused": true
}
Output Example
{
"Response": {
"RequestId": "114327ee-463c-4ee4-83f6-82e9a44bd81d"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| OperationDenied | Operation denied. |
| ResourceInUse | The resource is occupied. |