调用该接口为应用添加域名。

限制说明

  • 如果在企业版实例中调用该接口,请求参数IotInstanceId必须填写。否则,调用接口会失败。
  • 单阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。
    说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateStudioAppDomainOpen

系统规定参数。取值:CreateStudioAppDomainOpen。

AppId String a12*******

应用ID。可调用QueryStudioAppList查询。

Host String www.aliyun.test.com

域名。

ProjectId String a123******

项目ID。

1. 您可登录物联网应用开发控制台,在页面左上角选择对应实例后,在左侧导航栏单击项目管理。

2. 在普通项目列表中,找到目标项目,单击项目卡片,在地址栏中查看。

Protocol String https

请求协议。

  • https
  • http
IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。

  • 企业版实例:必须传入此参数。您可在物联网平台控制台的实例概览页面,查看您的企业版实例ID。
  • 公共实例:无需传入此参数。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。错误码详情,请参见错误码

Data Struct

应用添加域名的详情。

AppId String a12******

应用ID。

Host String www.aliyun.test.com

域名。

Id Integer 1573

域名ID。

IsBeian String YES

域名是否已备案。

  • YES:是。
  • NO:否。
ProjectId String a12*******

项目ID。

Protocol String https

请求协议。

TenantId String C70B541046F64EAABE3*******

租户ID。

ErrorMessage String 系统异常

调用失败时,返回的出错信息。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。

Success Boolean true

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateStudioAppDomainOpen
&AppId=a12*******
&Host=www.aliyun.test.com
&ProjectId=a123******
&Protocol=https
&<公共请求参数>

正常返回示例

XML格式

<CreateStudioAppDomainOpenResponse>    
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Data>
            <TenantId>C70B541046F64EAABE3*******</TenantId>
            <AppId>a12******</AppId>
            <ProjectId>a12*******</ProjectId>
            <Host>www.aliyun.test.com</Host>
            <Id>1573</Id>
            <Protocol>https</Protocol>
            <IsBeian>YES</IsBeian>
      </Data>
      <Success>true</Success>
</CreateStudioAppDomainOpenResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "TenantId": "C70B541046F64EAABE3*******",
        "AppId": "a12******",
        "ProjectId": "a12*******",
        "Host": "www.aliyun.test.com",
        "Id": 1573,
        "Protocol": "https",
        "IsBeian": "YES"
    },
    "Success": true
}