DescribeGatewayADInfo - Cloud Storage Gateway - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hcs-sgw:DescribeGatewayADInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	gw-000eg44nmxbsfwbvq***

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1B0CA0B9-2B0F-478D-ADC5-474C45BF947F
Message	string	The description of the request result.	successful
DomainName	string	The domain name used to connect to the AD server.	test***
IsEnabled	boolean	Indicates whether the AD server is enabled. Valid values: true: The AD server is enabled. false: The AD server is not enabled.	true
Username	string	The domain administrator.	alex***
ServerIp	string	The IP address of the AD server.	47.101.59.199
Code	string	The status code. A status code of 200 indicates that the request was successful.	200
Success	boolean	The result of the call. The return values are as follows: true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	GatewayNotExist	The specified gateway does not exist. You must specify a valid parameter.	The specified gateway does not exist. You must specify a valid parameter.
400	GatewayInUpgrading	The gateway is upgrading. Try again later.	The gateway is upgrading. Try again later.
400	GatewayInOperation	The gateway is processing requests . Try again later.	The gateway is busy. 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.