You can call this operation to query the status of the Alibaba Cloud Domain Name System (DNS) PrivateZone service under the current Alibaba Cloud account, for example, whether the service is activated, or whether the account has overdue payments.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeUserServiceStatus

The operation that you want to perform. Set the value to DescribeUserServiceStatus.

Lang String No en

The language of the specific content returned in the response.

UserClientIp String No 1.1.1.1

The IP address of the client.

Response parameters

Parameter Type Example Description
RequestId String 99626905-678A-4E8A-984E-6AEB09993996

The ID of the request.

Status String OPENED

The status of the Alibaba Cloud DNS PrivateZone service. Valid values:

  • CLOSED: The service is not activated.
  • OPENED: The service is activated.
  • IN_DEBT: The current account has overdue payments.
  • IN_DEBT_OVER_DUE: The overdue payments are not paid within the required period.

Examples

<><><>

Sample requests

  1. http://pvtz.aliyuncs.com/?Action=DescribeUserServiceStatus&<Common request parameters>

Sample success responses

XML format

  1. <DescribeUserServiceStatusResponse> <Status>OPENED</Status> <RequestId>9EA7F720-B7C0-45C1-9CF4-B6A5A1179B68</RequestId></DescribeUserServiceStatusResponse>

JSON format

  1. {“Status”:”CLOSED”,“RequestId”:”99626905-678A-4E8A-984E-6AEB09993996”}

Error codes

For a list of error codes, visit the API Error Center.