DescribeGatewayLDAPInfo - Cloud Storage Gateway - Alibaba Cloud Documentation Center

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
GatewayId	String	Yes	gw-000eg44nmxbsfwbvq***	The ID of the gateway.

Response parameters

Parameter	Type	Example	Description
RequestId	String	89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**	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.
BaseDN	String	dc=sgwte***,dc=local	The base DN of the LDAP server.
RootDN	String	cn=admin,dc=sgwte***,dc=local	The root DN of the LDAP server.
ServerIp	String	47.101.59.188	The IP address of the LDAP server.
IsTls	Boolean	false	Indicates whether Transport Layer Security (TLS) was used to encrypt data.
IsEnabled	Boolean	true	Indicates whether the LDAP server took effect.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeGatewayLDAPInfoResponse>
      <RootDN>cn=admin,dc=sgwte***,dc=local</RootDN>
      <Message>successful</Message>
      <RequestId>1B0CA0B9-2B0F-478D-ADC5-474C45BF947F</RequestId>
      <IsEnabled>true</IsEnabled>
      <BaseDN>dc=sgwte***,dc=local</BaseDN>
      <ServerIp>47.101.59.188</ServerIp>
      <IsTls>false</IsTls>
      <Code>200</Code>
      <Success>true</Success>
</DescribeGatewayLDAPInfoResponse>

JSON format

{
    "RootDN":"cn=admin,dc=sgwte***,dc=local",
    "Message":"successful",
    "RequestId":"1B0CA0B9-2B0F-478D-ADC5-474C45BF947F",
    "IsEnabled":true,
    "BaseDN":"dc=sgwte***,dc=local",
    "ServerIp":"47.101.59.188",
    "IsTls":false,
    "Code":"200",
    "Success":true
}

Error codes

HttpCode	Error code	Error message	Description
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	The error message returned because the gateway is being upgraded. Try again later.
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	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.
400	EmptyGatewayId	You must enter a valid ID for the gateway.	The error message returned because the gateway ID is not specified.

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