Dysmsapiclass="icms-help-docs-content">查询短链状态,可判断短链是否可用

查询短链状态，可判断短链是否可用。

接口说明

重要

短信服务暂时不支持使用此接口。

QPS 限制

本接口的单用户 QPS 限制为 20 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dysms:QueryShortUrl

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ShortUrl	string	是	生成的短链服务地址。可通过 AddShortUrl 接口获取。重要短信服务暂时不支持使用此接口。	http://****.cn/6y8uy7

返回参数

名称	类型	描述	示例值
	object
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Message	string	状态码的描述。	OK
RequestId	string	请求 ID。	819BE656-D2E0-4858-8B21-B2E477085AAF
Data	object	短链详情。
UniqueVisitorCount	string	短链使用的 UV 数据。	23
SourceUrl	string	原始链接地址。	https://www.****.com/product/sms
ShortUrlStatus	string	短链状态。取值： expired：失效。 effective：有效。 audit：审核中。 reject：审核拒绝。	expired
PageViewCount	string	短链使用的 PV 数据。	300
ExpireDate	string	短链失效时间。	2019-01-22 11:21:11
ShortUrlName	string	短链服务名称。	阿里短链测试
CreateDate	string	短链创建时间。	2019-01-08 16:44:13
ShortUrl	string	生成的短链服务地址。	http://****.cn/6y8uy7

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "819BE656-D2E0-4858-8B21-B2E477085AAF",
  "Data": {
    "UniqueVisitorCount": "23",
    "SourceUrl": "https://www.****.com/product/sms",
    "ShortUrlStatus": "expired",
    "PageViewCount": "300",
    "ExpireDate": "2019-01-22 11:21:11",
    "ShortUrlName": "阿里短链测试",
    "CreateDate": "2019-01-08 16:44:13",
    "ShortUrl": "http://****.cn/6y8uy7"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ForbiddenAction	Access to the account is denied. Please contact the administrator.

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

变更历史

更多信息，参考变更详情。