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
Action	String	Yes	DescribeGatewayLDAPInfo	The operation that you want to perform. Set the value to DescribeGatewayLDAPInfo.
GatewayId	String	Yes	gw-000eg44nmxbsfwbvq***	The ID of the gateway.

Response parameters

Parameter	Type	Example	Description
RootDN	String	cn=admin,dc=sgwte***,dc=local	The root distinguished name (DN) of the LDAP server.
RequestId	String	89398CFB-4EB6-4C7E-BB3C-EF213AC8FA**	The request ID.
Message	String	successful	The description of the request result.
IsEnabled	Boolean	true	Indicates whether the LDAP server took effect.
BaseDN	String	dc=sgwte***,dc=local	The base 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.
Code	String	200	The HTTP status code. The status code 200 indicates that the request was successful.
Success	Boolean	true	Indicates whether the request was successful.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<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

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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

HTTP status code	Error code	Error message	Description
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	The gateway is being upgraded. Try again later.
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. Check whether the parameter values are valid.
400	GatewayInOperation	The gateway is processing requests . Try again later.	The gateway is being operated on. Try again later.
400	GatewayStatusRunningRequired	The gateway is not in the Running state. Try again later.	The gateway is not in the Running state. Try again later.
400	EmptyGatewayId	You must enter a valid ID for the gateway.	No gateway ID is specified.

For a list of error codes, see Service error codes.