Queries the information about the Active Directory (AD) domain configured for a gateway.

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 DescribeGatewayADInfo

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

GatewayId String Yes gw-000eg44nmxbsfwbvq***

The ID of the gateway.

Response parameters

Parameter Type Example Description
RequestId String 1B0CA0B9-2B0F-478D-ADC5-474C45BF947F

The ID of the request.

Success Boolean true

Indicates whether the request is successful.

Code String 200

The HTTP status code. If the request is successful, 200 is returned.

Message String successful

The description of the status code.

Username String alex***

The username of the AD domain.

ServerIp String 47.101.59.199

The IP address of the AD domain.

DomainName String test***

The AD domain name.

IsEnabled Boolean true

Indicates whether the AD domain took effect. Valid values:

  • true: The AD domain took effect.
  • false: The AD domain failed to take effect.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeGatewayADInfo
&GatewayId=gw-000eg44nmxbsfwbvq***
&<Common request parameters>

Sample success responses

XML format 

<DescribeGatewayADInfoResponse>
      <DomainName>test***</DomainName>
      <Message>successful</Message>
      <RequestId>1B0CA0B9-2B0F-478D-ADC5-474C45BF947F</RequestId>
      <IsEnabled>true</IsEnabled>
      <ServerIp>47.101.59.199</ServerIp>
      <Username>alex***</Username>
      <Code>200</Code>
      <Success>true</Success>
</DescribeGatewayADInfoResponse>

JSON format 

{
    "DomainName":"test***",
    "Message":"successful",
    "RequestId":"1B0CA0B9-2B0F-478D-ADC5-474C45BF947F",
    "IsEnabled":true,
    "ServerIp":"47.101.59.199",
    "Username":"alex***",
    "Code":"200",
    "Success":true
}

Error codes

HttpCode Error code Error message Description
400 GatewayNotExist The specified gateway does not exist. You must specify a valid parameter. The error message returned because the specified gateway does not exist. Check whether the parameters are valid.
400 GatewayInUpgrading The gateway is upgrading. Try again later. The error message returned because the gateway is being upgraded. Try again later.
400 GatewayInOperation The gateway is processing requests . Try again later. The error message returned because another operation is in progress. Try again later.
400 GatewayStatusRunningRequired The gateway is not in the Running state. Try again later. The error message returned because the gateway is not in the Running state. Try again later.

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