Batch Deleting Tenant Domain Names
Function
This API is used to batch delete tenant domain names.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/composite-waf/hosts/batch-delete
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition Project ID, which is used to identify the project to which the tenant belongs. To obtain the project ID, log in to the console, click the username, choose My Credentials, locate the project in the Projects list, and check the project ID. Constraints N/A Range N/A Default Value N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Definition Enterprise project ID. You can obtain the enterprise project ID by calling the ListEnterpriseProject API of Enterprise Project Management Service (EPS). To query the resources associated with all enterprise projects of the current account, you do not need to specify this parameter. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition Tenant token, which is used for identity authentication. You can obtain the token by calling the IAM API for obtaining a user token. The token is the value of X-Subject-Token in the response header. Constraints N/A Range N/A Default Value N/A |
Content-Type |
Yes |
String |
Definition Content type, which specifies the data format of the request body. Constraints N/A Range N/A Default Value application/json;charset=utf8 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
host_ids |
No |
Array of strings |
Definition Domain ID array, which contains the unique IDs of the tenant domain names to be deleted in batches. The IDs can be obtained by calling the API for querying the tenant domain name list. Constraints N/A Range The elements in the array are strings. Each element corresponds to a domain name ID. Default Value N/A |
keep_policy_enable |
No |
Boolean |
Definition Whether to retain the protection policy for a deleted domain name. true: The protection policy will be retained. false: The protection policy will not be retained. Constraints N/A Range Only true and false are supported. Default Value false |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
host_ids |
Array of strings |
Definition Domain ID array, which contains the unique ID of each tenant domain name that has been deleted. Constraints N/A Range The elements in the array are strings, which correspond to the valid domain name IDs in the request body. Default Value N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error codes of the downstream service. |
error_msg |
String |
Error messages of the downstream service. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
encoded_authorization_message |
String |
You can call the decode-authorization-message interface of the STS service to decode the rejection reason. For details, see the STS5 joint commissioning and self-verification. This parameter is returned only when an IAM 5 authentication error occurs. |
details |
Array of IAM5ErrorDetails objects |
The set of error messages reported when a downstream service is invoked. This parameter is returned only when an IAM 5 authentication error occurs. |
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot