如何通过Cumulocity Java SDK获取微服务订阅租户状态

问题 #

需要通过Cumulocity Java SDK获取微服务订阅租户的状态值（"ACTIVE"/"SUSPENDED"/"DELETED"），已知可通过REST API GET {{baseurl}}/tenant/tenants/{tenantId}获取该值，但未找到SDK的直接实现方式。尝试用com.cumulocity.sdk.client.RestConnector调用该接口时收到HTTP 403 Forbidden错误，推测是微服务凭证/权限问题。

环境说明：

• Java微服务为"MULTI_TENANT"隔离模式
• cumulocity.json已配置角色：ROLE_TENANT_MANAGEMENT_ADMIN、ROLE_TENANT_MANAGEMENT_READ、ROLE_TENANT_ADMIN等
• 现有代码尝试遍历订阅租户，手动构建Platform实例并调用REST端点

解决方案 #

1. 使用SDK封装的TenantApi替代手动REST调用 #

Cumulocity Java SDK提供了TenantApi接口，已封装获取租户详情的逻辑，无需手动拼接URL或调用底层RestConnector。

2. 利用微服务上下文自动管理凭证 #

在多租户微服务中，通过MicroserviceSubscriptionsService.runForTenant()切换租户上下文后，Spring注入的Platform实例会自动使用当前租户的有效凭证，无需手动构建PlatformImpl。

修正后的代码示例 #

import com.cumulocity.microservice.context.credentials.MicroserviceCredentials;
import com.cumulocity.microservice.subscription.service.MicroserviceSubscriptionsService;
import com.cumulocity.rest.representation.tenant.TenantRepresentation;
import com.cumulocity.sdk.client.Platform;
import com.cumulocity.sdk.client.tenant.TenantApi;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class TenantStatusFetcher {
    private static final Logger log = LoggerFactory.getLogger(TenantStatusFetcher.class);

    @Autowired
    private MicroserviceSubscriptionsService subscriptionsService;

    @Autowired
    private Platform platform;

    public void fetchAllSubscribedTenantStatuses() {
        // 遍历所有订阅当前微服务的租户
        subscriptionsService.getAll().forEach(tenantCredential -> {
            // 切换到目标租户上下文执行操作
            subscriptionsService.runForTenant(tenantCredential.getTenant(), () -> {
                TenantApi tenantApi = platform.getTenantApi();
                try {
                    // 通过SDK获取租户详情
                    TenantRepresentation tenantRep = tenantApi.getTenant(tenantCredential.getTenant());
                    String tenantStatus = tenantRep.getStatus();
                    log.info("租户 {} 的状态为: {}", tenantCredential.getTenant(), tenantStatus);
                } catch (Exception e) {
                    log.error("获取租户 {} 状态失败", tenantCredential.getTenant(), e);
                }
            });
        });
    }
}

3. 权限问题排查与解决 #

如果仍出现403错误，需确认以下两点：

• 微服务服务账号权限：在Cumulocity管理界面的「应用程序」->「微服务」-> 目标微服务 ->「权限」中，确保服务账号拥有ROLE_TENANT_MANAGEMENT_READ权限（跨租户访问需要服务层面的权限）。
• 租户订阅时的角色配置：cumulocity.json中配置的roles会在租户订阅微服务时授予该租户，需确保这些角色包含访问租户详情的权限（ROLE_TENANT_MANAGEMENT_READ已足够）。

内容的提问来源于stack exchange，提问作者Pushkar