DescribeNamespace API Reference - AnalyticDB for PostgreSQL - Alibaba Cloud - AnalyticDB

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 supports 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

gpdb:DescribeNamespace

create

*Namespace

acs:gpdb:{#regionId}:{#accountId}:namespace/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	No	The instance ID. Note You can call the DescribeDBInstances operation to query all AnalyticDB for PostgreSQL instances in a region, including instance IDs.	gp-bp152460513z****
ManagerAccount	string	Yes	The name of the manager account that has the rds_superuser permission. Note You can create an account on the Account Management page of the AnalyticDB for PostgreSQL console or by calling the CreateAccount operation.	testaccount
ManagerAccountPassword	string	Yes	The password of the manager account.	testpassword
Namespace	string	Yes	The name of the namespace. Default value: public. Note You can call the ListNamespaces operation to query namespaces.	mynamespace
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
WorkspaceId	string	No	The workspace ID. A workspace consists of multiple AnalyticDB for PostgreSQL instances. Specify either WorkspaceId or DBInstanceId. If you specify both, WorkspaceId takes effect.	gp-ws-*****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
NamespaceInfo	object	The queried namespace.
	string	The queried namespace.	{}
Namespace	string	The name of the namespace.	mynamespace
DBInstanceId	string	The instance ID.	gp-bp152460513z****
RegionId	string	The region ID of the instance.	cn-hangzhou
Status	string	Whether the request was successful. Valid values: success fail	success
Message	string	The response message.	Successful

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "NamespaceInfo": {
    "key": "{}"
  },
  "Namespace": "mynamespace",
  "DBInstanceId": "gp-bp152460513z****",
  "RegionId": "cn-hangzhou",
  "Status": "success",
  "Message": "Successful"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.