文档

ListNamespaces - 获取命名空间列表

更新时间:
一键部署

获取命名空间列表。

接口说明

在调用该接口前,需要在POM文件添加以下依赖:

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-schedulerx2</artifactId>
    <version>1.0.5</version>
</dependency>

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。

cn-hangzhou
NamespaceNamestring

命名空间名称。

schedulerx-dev
Namespacestring

命名空间UID

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****

返回参数

名称类型描述示例值
object
Codeinteger

接口状态码。

200
Messagestring

附加信息。

message
RequestIdstring

请求唯一ID。

71BCC0E3-64B2-4B63-A870-AFB64EBCB58C
Successboolean

调用接口是否成功。取值如下:

  • true:成功。

  • false:失败。

true
Dataobject

命名空间列表信息。

Namespacesobject []

命名空间列表与详情。

Namestring

命名空间名称。

doc
Descriptionstring

命名空间描述。

test
UIdstring

命名空间ID。

1a72ecb1-b4cc-400a-a71b-20cdec9b****

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "message",
  "RequestId": "71BCC0E3-64B2-4B63-A870-AFB64EBCB58C",
  "Success": true,
  "Data": {
    "Namespaces": [
      {
        "Name": "doc",
        "Description": "test",
        "UId": "1a72ecb1-b4cc-400a-a71b-20cdec9b****"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-30API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用
2023-03-01OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:NamespaceName
    新增入参:Namespace
2022-12-26API 内部配置变更,不影响调用
变更项变更内容
API 内部配置变更,不影响调用

Demo

package com.alibaba.schedulerx.pop;

import java.util.List;

import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.exceptions.ServerException;
import com.aliyuncs.profile.DefaultProfile;
import com.aliyuncs.schedulerx2.model.v20190430.ListNamespacesRequest;
import com.aliyuncs.schedulerx2.model.v20190430.ListNamespacesResponse;
import com.aliyuncs.schedulerx2.model.v20190430.ListNamespacesResponse.Data.Namespace;

public class TestListNamespaces {

    public static void main(String[] args) {
        //OpenAPI的接入点,具体查看支持地域列表以及购买机器地域填写。
        String regionId = "cn-test";
        //鉴权使用的AccessKey ID,由阿里云官网控制台获取。
        String accessKeyId = "XXXXXXXX";
        //鉴权使用的AccessKey Secret,由阿里云官网控制台获取。
        String accessKeySecret = "XXXXXXXX";
        //产品名称。
        String productName ="schedulerx2";
        //对照支持地域列表选择Domain填写。
        String domain ="schedulerx.aliyuncs.com";
        //构建OpenAPI客户端。
        DefaultProfile.addEndpoint(regionId, productName, domain);
        DefaultProfile defaultProfile = DefaultProfile.getProfile(regionId, accessKeyId, accessKeySecret);
        DefaultAcsClient client = new DefaultAcsClient(defaultProfile);
        
        ListNamespacesRequest request = new ListNamespacesRequest();
        ListNamespacesResponse response;
        try {
            response = client.getAcsResponse(request);
            if (!response.getSuccess()) {
                System.out.println(response.getMessage());
            } else {
                List<Namespace> namespaces = response.getData().getNamespaces();
                for (Namespace namespace : namespaces) {
                    System.out.println("namespace uid=" + namespace.getUId());
                }
            }
        } catch (ServerException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (ClientException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }
    
}
  • 本页导读 (1)