All Products
Search

This Product

    :DescribeNamespaceList

    Document Center

    :DescribeNamespaceList

    Last Updated:Nov 01, 2024

    Queries a list of namespaces.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    sae:DescribeNamespaceListget
    • All Resources
      *
      none
    		none

    Request syntax

    GET /pop/v1/sam/namespace/describeNamespaceList HTTP/1.1

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ContainCustombooleanNo

    Specifies whether to return custom namespaces. Valid values:

    • true: The system returns custom namespaces.
    • false: The system does not return custom namespaces.
    		true
    HybridCloudExcludebooleanNo

    Specifies whether to exclude hybrid cloud namespaces from the result. Valid values:

    • true: The system excludes hybrid cloud namespaces from the result.
    • false: The system does not exclude hybrid cloud namespaces from the result.
    		true

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned data.

    RequestIdstring

    The request ID.

    		30375C38-F4ED-4135-A0AE-5C75DC7F****
    Messagestring

    The returned message. Valid values:

    • success: If the call is successful, success is returned.
    • An error code: If the call fails, an error code is returned.
    		success
    TraceIdstring

    The trace ID that is used to query the details of the request.

    		ac1a0b2215622920113732501e****
    Dataarray<object>

    The namespaces.

    RegionListobject
    VpcIdstring

    The ID of the virtual private cloud (VPC).

    		vpc-2ze0i263cnn311nvj****
    VSwitchIdstring

    The ID of the vSwitch.

    		vsw-2ze559r1z1bpwqxwp****
    Customboolean

    Indicates whether custom namespaces are returned. Valid values:

    • true: Custom namespaces are returned.
    • false: Custom namespaces are not returned.
    		true
    AgentInstallstring

    The command that was run to install the agent.

    		http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh
    NamespaceIdstring

    The ID of the namespace.

    		cn-beijing:test
    HybridCloudEnableboolean

    Indicates whether hybrid cloud namespaces are excluded. Valid values:

    • true: Hybrid cloud namespaces are excluded.
    • false: Hybrid cloud namespaces are included.
    		false
    SecurityGroupIdstring

    The ID of the security group.

    		sg-wz969ngg2e49q5i4****
    Currentboolean

    This parameter is no longer valid.

    		false
    NamespaceNamestring

    The name of the namespace.

    		test
    RegionIdstring

    The region to which the namespace belongs.

    		cn-beijing
    NameSpaceShortIdstring

    The short ID of the namespace.

    		test
    ErrorCodestring

    The error code. Valid values:

    • If the call is successful, the ErrorCode parameter is not returned.
    • If the call fails, the ErrorCode parameter is returned. For more information, see the Error codes section in this topic.
    		NULL
    Codestring

    The HTTP status code. Valid values:

    • 2xx: The call was successful.
    • 3xx: The call was redirected.
    • 4xx: The call failed.
    • 5xx: A server error occurred.
    		200
    Successboolean

    Indicates whether the list of namespaces was queried. Valid values:

    • true: The list was queried.
    • false: The list failed to be queried.
    		true

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "ac1a0b2215622920113732501e****",
  "Data": [
    {
      "VpcId": "vpc-2ze0i263cnn311nvj****",
      "VSwitchId": "vsw-2ze559r1z1bpwqxwp****",
      "Custom": true,
      "AgentInstall": "http://edas-bj.oss-cn-beijing-internal.aliyuncs.com/test/install.sh",
      "NamespaceId": "cn-beijing:test",
      "HybridCloudEnable": false,
      "SecurityGroupId": "sg-wz969ngg2e49q5i4****",
      "Current": false,
      "NamespaceName": "test",
      "RegionId": "cn-beijing",
      "NameSpaceShortId": "test"
    }
  ],
  "ErrorCode": "NULL",
  "Code": "200",
  "Success": true
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history