DescribeNamespaces-阿里云帮助中心

Queries the namespace information of an instance by calling DescribeNamespaces.

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

stream:DescribeVvpNamespaces

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Region	string	Yes	The region.	cn-beijing
InstanceId	string	Yes	The order instance ID.	f-cn-wwo36qj4g06
Namespace	string	No	The namespace name.	di-590843445844225
Tags	array<object>	No	The list of tags.
	object	No	The tag.
Value	string	No	The tag value.	test
Key	string	No	The tag key.	Flink
PageIndex	integer	No	The current page number.	1
PageSize	integer	No	The number of entries per page.	10
Ha	boolean	No	Specifies whether zone-disaster recovery is enabled.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	67F33190-946B-1105-B6A1-E2DF0426DD51
Success	boolean	Indicates whether the request was successful. Valid values: true: The request succeeded. false: The request failed.	true
TotalCount	integer	The total number of entries.	5
TotalPage	integer	The total number of pages.	2
PageIndex	integer	The current page number.	1
PageSize	integer	The number of entries per page.	10
Namespaces	array<object>	The list of namespaces.
	array<object>	The namespace information.
Status	string	The namespace status. Valid values: CREATING: The namespace is being created. DELETING: The namespace is being deleted. MODIFYING: The resource specifications are being modified. SUCCESS: The last operation succeeded. FAILED: The last operation failed.	SUCCESS
GmtCreate	integer	The creation time.	1629879567394
ElasticResourceSpec	object	The elastic resource specifications of the namespace.
Cpu	integer	The maximum CPU limit for pay-as-you-go resources.	0
MemoryGB	integer	The maximum memory limit for pay-as-you-go resources, in GB.	0
GmtModified	integer	The modification time.	1629879567394
ResourceSpec	object	The resource specification information.
Cpu	integer	The number of CPUs.	10
MemoryGB	integer	The memory size.	40
ResourceUsed	object	The resources that have been used.
Cu	number	The number of compute units (CUs) used.	0
Cpu	number	The number of CPUs used.	2
MemoryGB	number	The amount of memory used.	4
Ha	boolean	Indicates whether zone-disaster recovery is enabled for the namespace.	false
GuaranteedResourceSpec	object	The subscription resources allocated to the namespace.
Cpu	integer	The number of CPUs for subscription resources.	0
MemoryGB	integer	The memory size for subscription resources, in GB.	0
Namespace	string	The namespace name.	ns-1
Tags	array<object>	The list of tags.
	object	The tag.
Value	string	The tag value.	test
Key	string	The tag key.	flink

Examples

Success response

JSON format

{
  "RequestId": "67F33190-946B-1105-B6A1-E2DF0426DD51",
  "Success": true,
  "TotalCount": 5,
  "TotalPage": 2,
  "PageIndex": 1,
  "PageSize": 10,
  "Namespaces": [
    {
      "Status": "SUCCESS",
      "GmtCreate": 1629879567394,
      "ElasticResourceSpec": {
        "Cpu": 0,
        "MemoryGB": 0
      },
      "GmtModified": 1629879567394,
      "ResourceSpec": {
        "Cpu": 10,
        "MemoryGB": 40
      },
      "ResourceUsed": {
        "Cu": 0,
        "Cpu": 2,
        "MemoryGB": 4
      },
      "Ha": false,
      "GuaranteedResourceSpec": {
        "Cpu": 0,
        "MemoryGB": 0
      },
      "Namespace": "ns-1",
      "Tags": [
        {
          "Value": "test",
          "Key": "flink"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.