文档

ListServiceEntries - 查询分应用统计条目

更新时间:

查询分应用统计条目。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
iotcc:ListServiceEntriesRead
  • UIS
    acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}

请求参数

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

系统为分应用统计服务生成的ID,全网唯一。

c910061f-****-44e6-b659-***c
IoTCloudConnectorIdstring

云连接器实例ID。

iotcc-bp1odcab8tmno0hdq****
Targetarray

应用条目的目的地址。

string

应用条目的目的地址。最多支持输入20个目的地址。

192.168.1.32/27
TargetTypearray

应用条目的目的地址类型。

string

应用条目的目的地址类型,最多支持输入20个目的地址类型。取值:

  • Cidr:CIDR地址块。

  • Domain:域名。

Cidr
ServiceEntryStatusarray

应用条目的状态。

string

应用条目的状态。最多支持输入20个应用条目状态。取值:

  • Creating:创建中。

  • Created:已创建。

  • Deleting:删除中。

  • Updating:更新中。

Created
ServiceEntryNamearray

应用条目的名称。

string

应用条目的名称。最多支持输入20个应用条目名称。

长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

entry_name
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值范围:1~100。默认值:20

20
RegionIdstring

应用条目所在的地域ID。

您可以通过调用ListRegions接口获取地域ID。

cn-hangzhou
ServiceEntryIdsarray

应用条目的ID。

string

应用条目的ID。最多支持输入20个应用条目ID。

fwd-119smw5tkasdf****

返回参数

名称类型描述示例值
object

请求ID。

RequestIdstring

请求ID。

54B48E3D-DF70-471B-AA93-08E683A1B45
TotalCountinteger

总列表条目数。

10
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

20
ServiceEntriesarray

应用条目列表。

object

应用条目列表。

ServiceIdstring

系统为分应用统计服务生成的ID,全网唯一。

c910061f-****-44e6-b659-***c
ServiceEntryStatusstring

应用条目的状态。取值:

  • Creating:创建中。

  • Created:已创建。

  • Deleting:删除中。

  • Updating:更新中。

Created
Targetstring

应用条目的目的地址。

192.168.1.32/27
TargetTypestring

应用条目的目的地址类型。取值:

  • Cidr:CIDR地址块。

  • Domain:域名。

Cidr
ServiceEntryNamestring

应用条目的名称。

长度为2~128个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

entry_name
ServiceEntryDescriptionstring

应用条目的描述。

长度为2~256个字符,开头必须为大小写英文字母或中文,但不能为http://https://

entry_description
ServiceEntryIdstring

应用条目的ID。

fwd-119smw5tkasdf****

示例

正常返回示例

JSON格式

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20,
  "ServiceEntries": [
    {
      "ServiceId": "c910061f-****-44e6-b659-***c",
      "ServiceEntryStatus": "Created",
      "Target": "192.168.1.32/27",
      "TargetType": "Cidr",
      "ServiceEntryName": "entry_name",
      "ServiceEntryDescription": "entry_description",
      "ServiceEntryId": "fwd-119smw5tkasdf****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。

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

变更历史

变更时间变更内容概要操作
2021-11-18OpenAPI 错误码发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    新增错误码:400
  • 本页导读 (1)
文档反馈