DescribeNamespaces-阿里云帮助中心

Call DescribeNamespaces to retrieve project information for an instance.

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	Region.	cn-beijing
InstanceId	string	Yes	Order instance ID.	f-cn-wwo36qj4g06
Namespace	string	No	The name of the project.	di-590843445844225
Tags	array<object>	No	Tag list.
	object	No	Tag.
Value	string	No	Tag value.	test
Key	string	No	Tag key.	Flink
PageIndex	integer	No	Page number.	1
PageSize	integer	No	Number of entries per page.	10
Ha	boolean	No

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	67F33190-946B-1105-B6A1-E2DF0426DD51
Success	boolean	Indicates whether the request succeeded. Valid values: true: The request succeeded. false: The request failed.	true
TotalCount	integer	Total number of entries.	5
TotalPage	integer	Total number of pages.	2
PageIndex	integer	Current page number.	1
PageSize	integer	Number of entries per page.	10
Namespaces	array<object>	Project list.
	array<object>	Project information.
Status	string	Project status. Valid values: CREATING: Creating. DELETING: Deleting. MODIFYING: Modifying resource specifications. SUCCESS: The previous operation succeeded. FAILED: The previous operation failed.	SUCCESS
GmtCreate	integer	Creation time.	1629879567394
ElasticResourceSpec	object
Cpu	integer
MemoryGB	integer
GmtModified	integer	Modification time.	1629879567394
ResourceSpec	object	Resource specification information.
Cpu	integer	Number of CPUs.	10
MemoryGB	integer	Memory size, in GB.	40
ResourceUsed	object	Resources used.
Cu	number
Cpu	number	CPU units used.	2
MemoryGB	number	Memory used, in GB.	4
Ha	boolean
GuaranteedResourceSpec	object
Cpu	integer
MemoryGB	integer
Namespace	string	The name of the project.	ns-1
Tags	array<object>	Tag list.
	object	Tag.
Value	string	Tag value.	test
Key	string	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.